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.

module libtmux-elixir latest

Action

Shared results for explicit pane, window and session actions.

Source and package
Qualified name
LibTmux.Action
Module
LibTmux
Package
libtmux
Source
lib/libtmux/action.ex
LibTmux.Action

Description#

Pass a LibTmux.Server for one-shot execution or a LibTmux.Control for managed execution in its qualified connection. No action changes transport, replays a mutation or refreshes an observation. One-shot actions check the server incarnation before execution; that check leaves a check/use race.

Ordinary actions return completed, failed, skipped and unknown outcomes. value is populated only for a completed command; details retains the transport's original bounded evidence. Domain bang functions return the completed value or raise LibTmux.Action.CompletionError with the original unsuccessful result. Acknowledgement does not prove that a program processed input or finished running.

API errors use LibTmux.Error ; admitted control errors preserve the recovery handle in LibTmux.Control.ExecutionError . Domain bang functions raise these errors unchanged. Lower-level LibTmux.Control and LibTmux.Operation bang functions retain canonical outcomes as values.

Action errors with kind :invalid_command include a validation path such as [:options, :size] and a bounded details.reason describing accepted inputs. The reason appears in the exception message; rejected values are not retained in diagnostic details.

A nonzero one-shot client exit reports :failed with :observed certainty: its exit status is observed, not an authenticated tmux command reply or proof that no effects occurred.

Optional session context checks physical membership at tmux's command resolution. It does not bind a particular WindowLink index when a window has multiple links in that session. WindowLink references are rejected. See LibTmux.Pane.split/3 , LibTmux.Pane.send_text/4 and LibTmux.Window.rename/4 for caller examples.

Members4#

Esc

Type to search.

Reference preview Open reference