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

window.Window.set_typed_option

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

View as Markdown

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

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

The value must be the variant Self::typed_option reads back for the option; OptionValue gives the rules, and the two writes it cannot check. The value is marked sensitive, as in Self::set_option .

Errors

Returns crate::Error::OptionValueRefused without sending anything when tmux's option table refuses the value.

Returns crate::Error::OptionScopeMismatch when tmux keeps the option in another of its tables, and an error when tmux rejects the name or value.

Examples

window.set_typed_option("synchronize-panes", true).await?;
window.set_typed_option("main-pane-width", "50%").await?;

0 declared, 0 inherited

Esc

Type to search.