Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

function libtmux-elixir latest

Request.field/2

Reads a named format variable, optionally from an exact instance-bound target.

Source and package
Qualified name
LibTmux.Control.Request.field/2
Module
LibTmux.Control
Declared in
Request
Package
libtmux
Source
lib/libtmux/control/request.ex
field(variable, target \\ nil) @spec field(String.t(), LibTmux.Ref.t() | nil) :: t()

Description#

Existing empty fields succeed. A target that disappears before the read produces an acknowledged failed operation and leaves the connection usable. A reference does not reserve the object's lifetime.

See the worked example.

Parameters
Esc

Type to search.

Reference preview Open reference