Server.typed_option
Read one server option, decoded according to its declared kind.
Source and package
- Qualified name
-
libtmux::server:: Server:: typed _option - Module
- server
- Declared in
Server- Package
- libtmux
- Source
- crates/libtmux/src/server/settings.rs
- Other languages
- Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C# C++ Swift Kotlin Scala OCamlfunction F# Clojure
-
Description#
The one way to read a single option;
OptionValuesays how reads and writes fit together.TmuxText::from(value)recovers the exact bytes tmux stored.Nonemeans 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 asNone.Errors
Returns an error when tmux does not recognize the option name.
tmux options#
Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.
In other ports#
Read one server option
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no single-option read; Server.showOptions returns them all |
| Go | tmux |
| Java | reached through Server.options, whose Options.get reads one |
| C# | reached through Server.Options, whose TmuxOptions.GetAsync reads one |
| C++ | no single-option read; Server::options returns them all |
| Swift | Server |
| OCaml | Libtmux Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy. |
| Perl | Lib Pass scope => 'server' and the explicit target ID where applicable; inherited and global reads are deliberate options. |
No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.