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_filter:prepare/2

Bind a filter to one snapshot and check all required coverage first.

Source and package
Qualified name
tmux_filter:prepare/2
Declared in
tmux_filter
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_filter.erl
prepare/2 -spec prepare(t(), tmux_snapshot:t()) -> {ok, prepared()} | {error, map()}.

Description#

The prepared value can match only unmodified rows captured in that snapshot. It remains usable after the endpoint closes. It cannot refresh observations.

Examples#

1> {ok, F} = tmux_filter:new(pane, #{width => #{gte => 80}}), ok.
ok
2> tmux_filter:requirements(F).
[{collection,pane},{field,pane,width}]
Parameters
Esc

Type to search.

Reference previewOpen reference