Rust API

session.Session.typed_option

Rust

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

Module: session
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session/settings.rs
Other languages: Python Ruby Lua 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 session. 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.

In other ports Read one session option

Python libtmux.Session.show_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Session:get_option
TypeScript no single-option read; Session.showOptions returns them all
Go tmux.Session.RawOption
Java reached through Session.options, whose Options.get reads one
.NET reached through Session.Options, whose TmuxOptions.GetAsync reads one
C++ libtmux::Session::option
Swift Server.option(_:scope:)

0 declared, 0 inherited