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.

function libtmux-erlang latest

tmux_query:fetch/2

Execute the planned observation, full local predicate and final limit.

Source and package
Qualified name
tmux_query:fetch/2
Declared in
tmux_query
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_query.erl
fetch/2 -spec fetch(t(), fetch_options()) -> {ok, tmux_select:t()} | {error, map()}.

Description#

Capture options are those of tmux_server:snapshot/2. retry is 0 (default) or 1 and retries only inconsistent_capture, within the original capture deadline. The retry is a new read-only capture. No mutations are retried. Invalid capture requests return tagged errors, including unsupported consistency.

Examples#

1> tmux_query:fetch(tmux_query:panes(unopened), #{retry => 2}).
{error,#{code => invalid_query_options}}
Parameters

tmux command#

The tmux commands behind fetch/2.

list-panes -a server scope, cmd_list_panes_server (the server has a session) list-sessions list-windows -a server scope, cmd_list_windows_exec (the server has a session)

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference