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.

API reference

Browse the Elixir types and operations for working with tmux. Start with the core objects below, or search for a type or member.

Server 1 type
Server struct 10 members

Describes a local tmux server for capturing state and running commands.

Session 1 type
Session struct 11 members

An immutable session observation with explicit actions. Attachment retains tmux's client count.

Window 2 types
Window struct 11 members

An immutable physical window with explicit actions, independent of session membership and index.

WindowLink struct 7 members

An observed session/index/window binding. Its key is not a link lifetime ID.

Pane 1 type
Pane struct 25 members

An immutable physical pane with explicit actions. It belongs to a window; text may be empty.

Client 1 type
Client struct 8 members

An immutable attached-client observation, keyed by validated client name.

Commands 4 types
Command struct 5 members

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

Deadline struct 4 members

A node-local monotonic deadline shared by every stage of an operation.

Operation struct 18 members

A retained operation handle pinned to its original owner, tables and epoch.

OneShot module 4 members

Executes one explicitly selected executable with bounded captured output.

Control mode 2 types
Control struct 20 members

A qualified control connection for scoped and managed execution.

Protocol struct 7 members

Assembles bounded control-mode replies and lexical notifications from bytes.

Formats 2 types
Codec module 4 members

Decodes bounded field responses and control-output bytes.

Format module 2 members

Constructs literal operands for tmux formats without evaluating their text.

Queries 4 types
Filter struct 11 members

A validated portable predicate over one observed entity type.

Schema module 17 members

Defines observed fields, wire names and graph relations.

Selection struct 13 members

An ordered, materialized Enumerable over one captured entity type.

Wire module 4 members

Bounded JSON decoding with duplicate keys preserved until validation.

Snapshots 3 types
Capture module 2 members

Builds a bounded one-shot observation of one existing Linux tmux server.

Ref struct 9 members

An exact observed target bound to one server instance.

Snapshot struct 31 members

An indexed immutable graph observed over a capture interval.

Requests 1 type
Request struct 4 members

Data for the qualified control lane's supported commands.

Errors 4 types
CompletionError exception 2 members

An action result did not meet an explicit completion requirement.

ExecutionError exception 4 members

A managed execution reported an error after admission.

ScopeFailure exception 2 members

A scoped callback finished, but connection cleanup was not proved.

Error exception 9 members

An inspectable failure with its phase and certainty about effects.

Constants and enums 1 type
Action module 4 members

Shared results for explicit pane, window and session actions.

By module 4 modules

Esc

Type to search.

Reference preview Open reference