Rust API

pane.Pane.typed_option

Rust

Python
TypeScript Unavailable
Rust
Go
Java Unavailable
.NET Unavailable
C++
Swift

Module: pane
Declared in: Pane
Package: libtmux
Source: crates/libtmux/src/pane/settings.rs
Other languages: Python TypeScript Go Java .NET C++Swift

typed_option ( self , name : &str ) → Result<Option<OptionValue>, Error> method [source] ¶ method [source] ¶ typed_option

Read one option, decoded according to what tmux declares about it.

A flag comes back as OptionValue::Flag and a number as OptionValue::Number , so a caller does not decide for itself that on means one. Everything else, including user options, stays text. The one way to read a single option; OptionValue says how reads and writes fit together.

None means the option holds nothing at this pane. A user option, whose name begins with @, exists only while it is set, and a built-in one always exists, so both report an unset option as None.

Errors

Returns an error when tmux does not recognize the option name.

Discussed in Options and hooks

In other ports Read one pane option

Python libtmux.Pane.show_option
TypeScript no single-option read; Pane.showOptions returns them all
Go tmux.Pane.RawOption
Java reached through Pane.options, whose Options.get reads one
.NET reached through Pane.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Pane::option
Swift Server.option(_:scope:)

0 declared, 0 inherited