Rust API

method libtmux-rs latest

Server.set_typed_global_option

Set one global session option to a typed value, checked before it is sent.

Source and package

Qualified name: libtmux::server::Server::set_typed_global_option
Module: server
Declared in: Server
Package: libtmux
Source: crates/libtmux/src/server/settings.rs

pub async fn set_typed_global_option( &self, name: &str, value: impl Into<OptionValue>, ) -> Result<(), Error> method async [source] ¶

Description#

The value must be the variant Self::typed_global_option() reads back for the option; OptionValue gives the rules, and what is not checked.

Errors

Returns Error::OptionValueRefused without sending anything when tmux's option table refuses the value, and Error::OptionScopeMismatch when the option is not a session option. Otherwise returns an error when tmux rejects the name or value.

Examples#

server.set_typed_global_option("mouse", true).await?;
server.set_typed_global_option("history-limit", 50_000).await?;
server.set_typed_global_option("status-position", "top").await?;

Parameters

name (&str) #
value (impl Into<OptionValue>) #

tmux command#

The tmux commands behind set_typed_global_option.

set-option

tmux C API#

The C declarations in tmux that implement these commands.

cmd_set_option_entry cmd_set_option_exec

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.set_typed_global_option

Description#

Examples#

tmux command#

tmux C API#

Description#

Examples#

tmux command#

tmux C API#

Related types#