tmux_matcher behaviour (libtmux for Erlang v0.0.1)
View SourcePrepare a trusted local predicate once for a captured snapshot.
Use tmux_select:matching/2 with {Module, State}. The application chooses
Module; external filter documents cannot select the prepare/2
callback. Preparation returns a unary Boolean function or a tagged error.
Callback exceptions propagate. The adapter does not make executable predicates
portable or push them to tmux.
Summary
Callbacks
Prepare a local Boolean predicate once for this captured snapshot. Return a tagged preparation error when the matcher cannot operate. Callback exceptions remain application failures; this does not make a matcher portable or suitable for untrusted module selection.
Callbacks
-callback prepare(State :: term(), Snapshot :: tmux_snapshot:t()) -> {ok, fun((tmux_model:row()) -> boolean())} | {error, term()}.
Prepare a local Boolean predicate once for this captured snapshot. Return a tagged preparation error when the matcher cannot operate. Callback exceptions remain application failures; this does not make a matcher portable or suitable for untrusted module selection.