Struct tmux_interface::commands::options::set_option::SetOption

pub struct SetOption<'a>(pub TmuxCommand<'a>);

Structure for setting a pane/window/session/server option

Manual

tmux ^3.0:

tmux set-option [-aFgopqsuw] [-t target-pane] option value
(alias: set)

tmux ^2.6:

tmux set-option [-aFgoqsuw] [-t target-session | target-window] option value
(alias: set)

tmux ^1.8:

tmux set-option [-agoqsuw] [-t target-session | target-window] option value
(alias: set)

tmux ^1.7:

tmux set-option [-agqsuw] [-t target-session | target-window] option value
(alias: set)

tmux ^1.2:

tmux set-option [-agsuw] [-t target-session | target-window] option value
(alias: set)

tmux ^1.0:

tmux set-option [-agu] [-t target-session] option value
(alias: set)

tmux ^0.8:

tmux set-option [-gu] [-t target-session] option value
(alias: set)

Implementations

impl<'a> SetOption<'a>

pub fn new() -> Self

pub fn append(&mut self) -> &mut Self

[-a] - value is appended to the existing setting, if the option expects a string or a style

pub fn format(&mut self) -> &mut Self

[-F] - expand formats in the option value

pub fn global(&mut self) -> &mut Self

[-g] - the global session or window option is set

pub fn not_overwrite(&mut self) -> &mut Self

[-o] - prevents setting an option that is already set

pub fn quiet(&mut self) -> &mut Self

[-q] - suppress errors about unknown or ambiguous options

pub fn server(&mut self) -> &mut Self

[-s] - set a server option

pub fn unset(&mut self) -> &mut Self

[-u] - unset an option, so a session inherits the option from the global options

pub fn window(&mut self) -> &mut Self

[-w] - set a window option

pub fn target(&mut self, target: &'a str) -> &mut Self

[-t target-session | target-window]

pub fn option<S: Into<Cow<'a, str>>>(&mut self, option: S) -> &mut Self

option

pub fn value<S: Into<Cow<'a, str>>>(&mut self, value: S) -> &mut Self

value

pub fn output(&self) -> Result<TmuxOutput, Error>

Trait Implementations

impl<'a> Clone for SetOption<'a>

fn clone(&self) -> SetOption<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for SetOption<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for SetOption<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'_ TmuxCommand<'a>> for SetOption<'a>

fn from(item: &TmuxCommand<'a>) -> Self

Performs the conversion.

impl<'a> From<TmuxCommand<'a>> for SetOption<'a>

fn from(item: TmuxCommand<'a>) -> Self

Performs the conversion.