Rust API

pane.Pane.set_typed_option

Rust

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

// A choice takes the word it reads back as, not a flag.
pane.set_typed_option("remain-on-exit", "failed").await?;

0 declared, 0 inherited