Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Rust API

Rust documentation

server.Server.set_typed_global_option

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

View as Markdown

Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/settings.rs
set_typed_global_option ( self , name : &str , value : impl Into<OptionValue> ) → Result<(), Error>
method [source]
method [source]
set_typed_global_option

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

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?;

0 declared, 0 inherited

Esc

Type to search.