Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

typealias libtmux-erlang latest

tmux_operation:failure/0

A tagged error detail with a stable code and optional certainty/output data. Validation, admission and wait errors may contain only code. Command failures retain available stdout/stderr, stdin_delivered and exit_status. Other keys provide code-specific context. Never infer missing certainty fields.

Source and package
Qualified name
tmux_operation:failure/0
Declared in
tmux_operation
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_operation.erl
-type failure() :: #{code := atom(), outcome => outcome(), cleanup => cleanup(), stdout => binary(), stderr => binary(), stdin_delivered => non_neg_integer(), exit_status => integer(), submitted => boolean(), atom() => term()}.

Description#

Common codes are busy, invalid_operation_options, command_error, deadline, cancelled, stale_server, cleanup_incomplete, await_timeout and operation_expired. command_error means a nonzero client exit; it does not roll back a mutation. await_timeout abandons only this wait. operation_expired cannot reconstruct a previous result or establish its remote outcome.

Guides#

Pages that discuss failure/0.

Esc

Type to search.

Reference previewOpen reference