Struct tmux_interface::commands::options::show_options::ShowOptions

pub struct ShowOptions<'a> {
    pub include_inherited: bool,
    pub global: bool,
    pub hooks: bool,
    pub pane: bool,
    pub quiet: bool,
    pub server: bool,
    pub value: bool,
    pub window: bool,
    pub target: Option<Cow<'a, str>>,
    pub option: Option<Cow<'a, str>>,
}

Structure for showing options

Manual

tmux ^3.0:

show-options [-AgHpqsvw] [-t target-pane] [option]
(alias: show)

tmux ^1.8:

show-options [-gqsvw] [-t target-session | target-window] [option]
(alias: show)

tmux ^1.7:

show-options [-gsw] [-t target-session | target-window] [option]
(alias: show)

tmux ^1.2:

show-options [-gsw] [-t target-session | target-window]
(alias: show)

tmux ^1.0:

show-options [-t target-session]
(alias: show)

tmux ^0.8:

show-options [-t target-session] option value
(alias: show)

Fields

include_inherited: bool

[-A] - includes options inherited from a parent set of options

global: bool

[-g] - global session or window options are listed

hooks: bool

[-H] - includes hooks (omitted by default)

pane: bool

[-p] - show window options

quiet: bool

[-q] - no error will be returned if option is unset

server: bool

[-s] - show the server options

value: bool

[-v] - shows only the option value

window: bool

[-w] - show the window options

target: Option<Cow<'a, str>>

[-t target-pane] - target session or window name

option: Option<Cow<'a, str>>

[option] - specify option name

Implementations

impl<'a> ShowOptions<'a>

pub fn new() -> Self

pub fn include_inherited(self) -> Self

[-A] - includes options inherited from a parent set of options

pub fn global(self) -> Self

[-g] - global session or window options are listed

pub fn hooks(self) -> Self

[-H] - includes hooks (omitted by default)

pub fn pane(self) -> Self

[-p] - show window options

pub fn quiet(self) -> Self

[-q] - no error will be returned if option is unset

pub fn server(self) -> Self

[-s] - show the server options

pub fn value(self) -> Self

[-v] - shows only the option value

pub fn window(self) -> Self

[-w] - show the window options

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

[-t target-pane] - target session or window name

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

[option] - specify option name

pub fn build(self) -> TmuxCommand<'a>

Trait Implementations

impl<'a> Clone for ShowOptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ShowOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ShowOptions<'a>

fn default() -> ShowOptions<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.