Pane.set_typed_option
Set one option to a typed value, checked before it is sent.
Source and package
- Qualified name
-
libtmux::pane:: Pane:: set _typed _option - Module
- pane
- Declared in
Pane- Package
- libtmux
- Source
- crates/libtmux/src/pane/settings.rs
-
Description#
The value must be the variant
Self::typed_option()reads back for the option;OptionValuegives the rules, and the two writes it cannot check. The value is marked sensitive, as inSelf::set_option().Errors
Returns
crate::Error::OptionValueRefusedwithout sending anything when tmux's option table refuses the value.Returns
crate::Error::OptionScopeMismatchwhen 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?;
tmux command#
The tmux commands behind set_typed_option.
tmux C API#
The C declarations in tmux that implement these commands.