Format.field/1
Encodes one named field for LibTmux.Codec.decode_field/3 with encoding: :escaped_v1.
Source and package
- Qualified name
-
LibTmux .Format .field/1 - Module
- LibTmux
- Declared in
- Format
- Package
- libtmux
- Source
- lib/libtmux/format.ex
-
Description#
Backslashes are replaced first, then dollars and ASCII control bytes. This protects values from tmux 3.4's ambiguous print escaping. The
v1:prefix and encoded newlines prevent field text from becoming reply guards. This encodes one field. Capture composes these fields inside its versioned row framing; this is not an arbitrary format wrapper. The caller must still bound the response and validate the field against its schema and the connected server's capabilities.See the worked example.
Discussed in Command and field encoding