Pane.options
Read every option set on this pane, decoded by its declared kind.
Source and package
-
Description#
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, andSelf::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?;
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.
Guides#
Pages that discuss options.
In other ports#
Read the options set on a pane
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | pane |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| OCaml | Libtmux Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy. |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.