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.

typealias libtmux-elixir latest

Action.result/1

Canonical action outcome and original transport evidence.

Source and package
Qualified name
LibTmux.Action.result/1
Module
LibTmux
Declared in
Action
Package
libtmux
Source
lib/libtmux/action.ex
@type result(value) :: %{ outcome: :completed, certainty: LibTmux.Error.certainty(), evidence: atom(), transport: :one_shot | :control, value: value, details: map() } | %{ outcome: :failed | :skipped | :unknown, certainty: LibTmux.Error.certainty(), evidence: atom(), transport: :one_shot | :control, value: nil, details: map() }

Description#

A completed outcome carries the action's value; failed, skipped and unknown outcomes carry nil . Match the outcome before using the value. Command acknowledgement remains distinct from external program completion.

A completed split carries t:LibTmux.Pane.split_value/0 . See LibTmux.Pane.split/3 for its identity and lifetime limits.

Type parameters
Esc

Type to search.

Reference preview Open reference