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

Command

A command value with separate argv and tmux-text renderers.

Source and package
Qualified name
LibTmux.Command
Module
LibTmux
Package
libtmux
Source
lib/libtmux/command.ex
struct LibTmux.Command

Description#

Construction performs no I/O. Arguments are bytes without NUL. Rendering protects command syntax; arguments interpreted as formats still require LibTmux.Format . A command value does not authorize a shared control lane or establish completion behavior, including configured hooks and aliases.

Discussed in Command and field encoding

Members5#

Common operations2#

  • argv/2 function Returns process arguments, preserving terminal semicolons in tmux's argv parser.
  • render/2 function Renders one newline-free tmux command line within its encoded byte budget.

Other members3#

  • new/3 function Constructs a trusted command, rejecting invalid arguments and input size.
  • option/0: option() :: {:max_bytes, pos_integer()} typealias A positive byte ceiling for the selected argv or text rendering; encoded output is charged separately.
  • t/0 typealias Trusted command data without I/O. Format operands need separate encoding before execution.
Esc

Type to search.

Reference preview Open reference