Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

typealias libtmux-erlang latest

tmux_schema:field_metadata/0

Generated field contract. stable is a versioned portable identity; wire is the JSON key. required controls construction and nullable permits known absence. format is present only for directly observed tmux fields; derived fields omit it. capture_codec identifies an admitted batched source encoding; its absence selects isolated reads for that entity. minimum tightens an integer field's lower bound. Field names themselves are the keys returned by fields/1, not this map's wire or stable values.

Source and package
Qualified name
tmux_schema:field_metadata/0
Declared in
tmux_schema
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_schema.erl
-type field_metadata() :: #{type := value_type(), wire := binary(), stable := binary(), required := boolean(), nullable := boolean(), format => binary(), capture_codec => escaped_columns_v1, minimum => integer()}.
Esc

Type to search.

Reference previewOpen reference