Rust API

server.Server.typed_option

Rust

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

Module: server
Declared in: Server
Package: libtmux
Source: crates/libtmux/src/server/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 server option, decoded according to its declared kind.

The one way to read a single option; OptionValue says how reads and writes fit together. TmuxText::from(value) recovers the exact bytes tmux stored.

None means the option holds nothing: a built-in option that is unset, or a user option that was never set. tmux prints nothing for an option set to the empty string either, so that also reads as None.

Errors

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

In other ports Read one server option

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

0 declared, 0 inherited