Rust API reference | libtmux-rs

window_layout and select-layout using a JSON subset instead of the classic checksum-prefixed string, and so crate::LayoutSpec::Saved accepting one.

LIST_KEYS_FORMAT constant

list-keys -F, and so crate::Server::typed_key_bindings().

MIRRORED_LAYOUTS constant

The mirrored layouts, and so crate::Layout::MainHorizontalMirrored and crate::Layout::MainVerticalMirrored.

NAMED_BUFFER_IDENTITY constant

Exact delete-buffer -b and set-buffer -b -n identity.

PANE_BORDER_STYLE_PER_PANE constant

pane-border-style and pane-active-border-style becoming pane options as well as window ones, below it tmux stores them only per window, and a write sent with -p lands there instead -- reporting success for a change the caller did not ask for. See crate::OptionSchema::accepts().

Commands 5 types

Command struct 5 members

A logical tmux command with classified diagnostic arguments.

CommandChain struct 4 members

Several tmux commands dispatched as one tmux a \; b invocation.

CommandSummary struct 3 members

A rendering of a dispatched command that is safe to log.

DispatchLimits struct 4 members

How much work one server may have in flight at once.

TmuxArg struct 3 members

Text bound for a tmux argument that tmux expands as a format.

Control mode 6 types

Subscription enum 5 members

What a subscription watches.

ControlSender struct 10 members

Sends commands down a control-mode connection.

ControlEvents struct 2 members

Receives tmux notifications and terminal connection errors.

PaneOutput struct 5 members

What one pane writes, as it writes it.

ControlClientLimits struct 4 members

How many persistent control-mode clients one server may hold.

ControlLimits struct 6 members

What one control-mode connection may accumulate before it gives up.

Formats 1 type, 1 function or constant

TmuxText struct 6 members

Immutable text bytes returned by tmux.

escape_format function

Escape text so tmux uses it as written rather than expanding it.

Queries 9 types, 8 functions and constants

Matcher trait 1 member

A predicate that evaluates a borrowed candidate.

QueryIteratorExt trait 4 members

Cardinality and named-predicate operations for native iterators.

FilterEnum trait 1 member

Stable string semantics for a custom enum filter field.

Filterable trait 1 member

A type with a stable schema that can evaluate portable filter predicates.

ManyRelation struct 3 members

A value-only handle for a to-many relation from From to To.

OneRelation struct 1 member

A value-only handle for a to-one relation from From to To.

FilterSchema trait

A filter target whose portable expression grammar can be described.

FilterSchemaDescriptor struct 3 members

One target and every field its decoder accepts.

FilterValueSchema enum 7 members

The value or relation family behind one filter field.

bool_field function

Construct a boolean handle for generated code.

enum_field function

Construct a custom enum handle for generated code.

filter_schema function

Return generated metadata for one related target.

integer_field function

Construct an integer handle for generated code.

many_relation function

Construct a to-many relation handle for generated code.

one_relation function

Construct a to-one relation handle for generated code.

text_field function

Construct a text handle for generated code.

unknown_field_error function

Construct the source-less generated fallback for an unknown field.

Queries — Fields 6 types

TextField struct 12 members

A typed handle for a portable text field on T.

BoolField struct 3 members

A typed handle for a portable boolean field on T.

IntegerField struct

A typed handle for a fixed-width integer field N on T.

EnumField struct 3 members

A typed handle for a custom enum field E on T.

FilterFieldSchema struct 1 member

One accepted field and the predicates valid for it.

ReadField trait

A field handle whose value a Target snapshot holds.

Queries — Expressions 2 types

FilterExpr struct 4 members

An opaque, portable predicate over candidates of type T.

Predicate struct 14 members

One opaque predicate passed to generated candidate dispatch.

Snapshots 5 types

CapturedLine struct 4 members

One line of a capture, with what tmux knows about it.

CapturePane struct 2 members

Read a pane's contents.

Availability enum 7 members

A snapshot field's value, or the reason the snapshot holds none.

PaneProgressState enum 5 members

Closed progress-state vocabulary tmux emits for a pane's progress bar.

Sealed trait

Keeps super::ReadField implemented by this crate's handles only.

Workspaces 7 types

Effects struct 5 members

What an operation does to tmux state.

Safety enum 3 members

How an operation directly affects tmux objects.

SetOption struct 3 members

Set a tmux option.

SetEnvironment struct 1 member

Set a variable in a session's environment.

SendKeys struct 4 members

Send text or named keys to a pane.

Pause struct 2 members

Wait before the next operation runs.

SelectLayout struct 1 member

Rearrange a window's panes into a named or described layout.

Workspaces — Plans 3 types

Plan struct 10 members

Operations recorded but not yet run.

Planner enum 6 members

How a plan is grouped into tmux invocations.

WorkspaceReadme struct

Compiles the workspace README's examples, and nothing else.

Workspaces — Steps 10 types

Operation trait

An operation that can be recorded in a Plan.

Chainable trait

An operation that may share one tmux invocation with its neighbours.

FromStep trait 1 member

Turns a recorded step index into whatever Plan::add() returns for it.

Step struct 5 members

One tmux invocation: the operations it carries, in order.

StepReason enum 5 members

Why a Step is its own tmux invocation.

Outcome enum 5 members

How an operation ended.

Attribution enum 2 members

How much a run could tell about each operation's outcome.

OperationValue enum 5 members

The typed value one operation produced.

OperationReport struct 5 members

What one recorded operation produced, in plan order.

StepOutcome struct 7 members

What one dispatched invocation produced.

Workspaces — Targets and slots 9 types

Scope class 3 members

The tmux object an operation addresses or makes.

Slot struct 3 members

A typed reference to the object a recorded operation will create.

SessionSlot struct

Marker for a slot that points at a session.

WindowSlot struct

Marker for a slot that points at a window.

PaneSlot struct

Marker for a slot that points at a pane.

PaneTarget enum 2 members

A -t target naming a pane, resolved when the plan runs.

WindowTarget enum 2 members

A -t target naming a window, resolved when the plan runs.

SessionTarget enum 2 members

A -t target naming a session, resolved when the plan runs.

SplitTarget enum 2 members

split-window's -t: a window (its active pane divides) or an exact pane. -t <window> always resolves to the active pane, which a detached split never changes, so a chain of splits needs the pane form (SplitWindow::from_pane()) after the first.

Workspaces — Session 1 type

NewSession struct 3 members

Create a session.

Workspaces — Window 5 types

SplitWindow struct 8 members

Split a window, making a pane.

NewWindow struct 7 members

Create a window in a session.

SelectWindow struct 1 member

Make a window the active one.

RenameWindow struct 1 member

Rename a window.

KillWindow struct 2 members

Destroy a window.

Workspaces — Pane 2 types

SelectPane struct 1 member

Make a pane the active one.

KillPane struct 2 members

Destroy a pane.

Errors 12 types

ControlModeErrorKind enum 9 members

Why a control-mode connection failed.

OptionErrorKind enum 3 members

Which way tmux would not accept an option.

ErrorKind enum 10 members

A coarse failure category for reporting and routing.

IdParseError struct 1 member

An invalid scope-specific tmux object ID.

Error enum 50 members

An error returned by libtmux.

ObjectKind enum 4 members

The kind of tmux object a failure refers to.

ListingDecodeError struct 2 members

Payload-free metadata describing why tmux output could not be decoded.

ScopeError enum 7 members

A scoped resource's creation, operation, or cleanup failure.

PlanValidationError struct 5 members

An invalid dependency between two plan steps, or a step whose own arguments cannot render as one tmux command.

ExactlyOneError enum 2 members

The ways an iterator can fail to contain exactly one item.

MultipleItemsError struct

An error indicating that an iterator contained more than one item.

FilterExpressionError struct 1 member

A source-less, value-free portable expression validation error.

Errors — Server 2 types

ServerConfigurationErrorKind enum 9 members

The category of an invalid crate::ServerBuilder configuration.

ServerGoneKind enum 4 members

Which way a tmux server was not there.

Errors — Session 1 type

SessionNameError enum 2 members

Why a session name is one tmux could not address.

Constants and enums 15 types

CommandResult struct 13 members

The exact status and output captured for one tmux command.

Event enum 30 members

Something tmux reported that no command asked for.

BlockResult struct 4 members

The outcome of one command sent over control mode.

ControlMode struct 7 members

One control-mode connection to a tmux server.

ReplaceMode enum 2 members

Whether writing a hook keeps the entries it does not name.

OptionKind enum 7 members

What kind of value an option holds.

CaptureOptions struct 9 members

How far back a capture reaches, and in what form.

PlanValidationErrorKind enum 6 members

Why a plan dependency is invalid.

PlanResult struct 5 members

What running a plan produced.

FilterExpressionErrorKind enum 9 members

The category of an invalid portable filter expression.

IntegerKind enum 10 members

The fixed-width integer types understood by generated schema checks.

AccessMode enum 2 members

How much a user on the server's access list may do.

PromptKind enum 4 members

Which prompt tmux is remembering answers for.

JoinOptions struct 3 members

Where a pane lands when it is moved into another window.

SplitOptions struct 8 members

Options for splitting a window or pane into a new pane.

Constants and enums — Session 1 type

NewSessionOptions struct 6 members

Options for creating a session.

Constants and enums — Window 1 type

NewWindowOptions struct 9 members

Options for creating a window in a session.

Testing utilities 6 types, 5 functions and constants

TestServerErrorKind enum 10 members

The category of a TestServer lifecycle failure.

TestServerError struct 2 members

A source-less, redacted failure from TestServer.

TestServerBuilder struct 6 members

A consuming builder for an isolated foreground tmux test server.

TestServer struct 8 members

One isolated tmux daemon and its descriptor-relative cleanup guard.

DaemonState enum 4 members

Whether a fixture's tmux daemon is still running, and how it ended if not.

RetryTimeout struct 1 member

A condition did not hold before its deadline.

install_executable function

Write script to path as an executable, and return once it can run.

reap_abandoned_servers function

Kill tmux servers left behind by fixtures that never cleaned up.

retry_until function

Poll until a condition holds, or the deadline passes.

scaled function

Widen a fixture deadline by LIBTMUX_TEST_TIMEOUT_SCALE.

unique_name function

Build a name no other caller in this process will produce.

Internal 5 functions and constants

__fuzz_control_blocks function

Frame arbitrary control-mode output into replies, and check each reply.

__fuzz_format_rows function

Decode arbitrary listing output, then check that decoding inverts tmux.

__fuzz_layout function

Exercise layout validation for fuzzing; not a supported API.

__fuzz_parse_control_line function

Parse one control-mode protocol line, for fuzzing only.

__fuzz_parse_key_bindings function

Decode list-keys -F output, for fuzzing only.

Other 8 types

Runtime struct 3 members

A runtime for calling this crate's async methods from ordinary code.

OutputLimits struct 6 members

How many bytes one dispatch may read from each stream.

DesignNotes struct

The design notes, compiled.

Findings struct

The findings catalogue, compiled for the same reason as DesignNotes.

MigrationGuide struct

SandboxCanary struct

Checks that a doctest runs inside the tmux sandbox.

MacrosReadme struct

Compiles the libtmux-macros README's examples, and nothing else.

Readme struct

Compiles the README's Rust blocks. The README is the command's page on crates.io, not this crate's documentation, so it renders nowhere here.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

API reference

By module 54 modules