read_formats

read_formats( connection::LibTmux.ControlConnection, target, fields::AbstractVector{<:LibTmux.FormatField}; kwargs... )[source]#

read_formats( connection::LibTmux.ControlConnection, target, fields::LibTmux.FormatField...; kwargs... )[source]#

Read typed fields over a pinned control connection, with the target contexts and empty-value semantics of the subprocess method. Names outside the snapshot catalog remain valid. The escaped row grammar preserves tabs, newlines and guard-looking text without admitting arbitrary command output.

read_formats(connection::ControlConnection, target, fields::FormatField...; kwargs...)
read_formats(connection::ControlConnection, target, fields::AbstractVector{<:FormatField}; kwargs...)

The connection enforces its generation and never falls back to a subprocess. strict=false does not weaken this identity contract. FormatValueError.result retains the actual ControlResult . max_output_bytes bounds the encoded reply, including row prefix and escapes; the connection's frame limit also applies.

read_formats( server::LibTmux.Server, target, fields::AbstractVector{<:LibTmux.FormatField}; kwargs... )[source]#

read_formats(server::LibTmux.Server, target, fields::LibTmux.FormatField...; kwargs...)[source]#

Read 1–256 fields with the lossless row codec, preserving field order and duplicates. Tabs, newlines, backslashes and Unicode remain literal values. Return FormatObservation values; empty expansions remain unverified. Nonempty invalid numeric or Boolean values raise FormatValueError .

read_formats(server, target, fields::FormatField...; kwargs...)
read_formats(server, target, fields::AbstractVector{<:FormatField}; kwargs...)

The target is mandatory. PaneRef selects the physical pane. SessionRef selects its active window and pane; WindowRef selects its active pane and tmux chooses a linked-session context. Use a session target for contextual session fields; a physical window has no unique session. Client references are not supported by this API. Identity checks are best effort; strict=true refuses execution. Deadline and cancellation options follow new_session .

These descriptors use names from the snapshot catalog without limiting callers to that catalog:

read_formats(server, pane_ref,
             FormatField("pane_width", Int), FormatField("pane_active", Bool),
             FormatField("version"))