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

Window.set_typed_option

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

Source and package
Qualified name
libtmux::window::Window::set_typed_option
Module
window
Declared in
Window
Package
libtmux
Source
crates/libtmux/src/window/settings.rs
pub async fn set_typed_option( &self, name: &str, value: impl Into<OptionValue>, ) -> Result<(), Error>

Description#

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

tmux command#

The tmux commands behind set_typed_option.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference