On this page

pane.settings.Pane.options

Module: pane.settings
Declared in: Pane
Package: libtmux
Source: crates/libtmux/src/pane/settings.rs

options ( self ) → Result<BTreeMap<String, OptionValue>, Error> method [source] ¶ method [source] ¶ options

Read every option set on this pane, decoded by its declared kind.

Costs one tmux command per option, because each value is read as the bytes tmux stored rather than the form it lists them in. Use Self::option_names when only the names are wanted, and Self::typed_option for one value.

Reports what is set *at this scope*, not what the object resolves to. A session that has set nothing of its own answers empty even though every option still has an effective value it inherits.

Errors

Returns an error when tmux cannot be reached or refuses the listing. An empty map means nothing is set, never that the listing failed.

Examples

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("opts").await?;
let window = session.active_window().await?.expect("a session has a window");
let pane = window.active_pane().await?.expect("a window has a pane");

pane.set_option("@marker", "set").await?;
assert!(pane.options().await?.contains_key("@marker"));

guard.shutdown().await?;

Discussed in Options and hooks

0 declared, 0 inherited