Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-rs latest

Server.typed_global_window_option

Read one global window option, decoded according to its declared kind.

Source and package
Qualified name
libtmux::server::Server::typed_global_window_option
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/settings.rs
pub async fn typed_global_window_option( &self, name: &str, ) -> Result<Option<OptionValue>, Error>

Description#

Windows inherit from this table. Absence and decoding work as in Self::typed_option().

Errors

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

Examples#

use libtmux::OptionValue;
let base = server.typed_global_window_option("pane-base-index").await?;
assert!(matches!(base, Some(OptionValue::Number(_))));
Parameters
Esc

Type to search.

Reference previewOpen reference