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.

struct libtmux-elixir latest

Request

Data for the qualified control lane's supported commands.

Source and package
Qualified name
LibTmux.Control.Request
Module
LibTmux.Control
Package
libtmux
Source
lib/libtmux/control/request.ex
struct LibTmux.Control.Request

Description#

Field reads encode one named variable losslessly. Server user options accept literal binary values. Domain actions use the same lane for split, rename and literal/named input. Constructing a request performs no I/O; use LibTmux.Control.execute/3 or retain a handle with LibTmux.Control.submit/3 . The host must qualify hooks, aliases and mode-dependent input bindings along with other stream writers. Arbitrary commands, formats and raw control lines require separate qualification and are not accepted by this lane.

Members4#

  • field/2 function Reads a named format variable, optionally from an exact instance-bound target.
  • set_user_option/2 function Sets a server user option with an @name and a literal binary value.
  • t/0 typealias Command data for the qualified lane; construction does not validate admission or perform I/O.
  • verify_reply/3 function Checks a qualified request's reply shape; a tmux error reply remains a command outcome.
Esc

Type to search.

Reference preview Open reference