Struct ServerOptions

pub struct ServerOptions<'a> {

    pub backspace: Option<Cow<'a, str>>,
    pub buffer_limit: Option<usize>,
    pub command_alias: Option<Vec<Cow<'a, str>>>,
    pub copy_command: Option<Cow<'a, str>>,
    pub default_terminal: Option<Cow<'a, str>>,
    pub escape_time: Option<usize>,
    pub editor: Option<Cow<'a, str>>,
    pub exit_empty: Option<Switch>,
    pub exit_unattached: Option<Switch>,
    pub extended_keys: Option<Switch>,
    pub focus_events: Option<Switch>,
    pub history_file: Option<Cow<'a, str>>,
    pub message_limit: Option<usize>,
    pub prompt_history_limit: Option<usize>,
    pub set_clipboard: Option<SetClipboard>,
    pub terminal_features: Option<Vec<Cow<'a, str>>>,
    pub terminal_overrides: Option<Vec<Cow<'a, str>>>,
    pub user_keys: Option<Vec<Cow<'a, str>>>,
    pub user_options: HashMap<String, Option<Cow<'a, str>>>,
}

Fields

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

backspace key

buffer_limit: Option<usize>

buffer-limit number

command_alias: Option<Vec<Cow<'a, str>>>

command-alias[] name=value

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

copy-command shell-command

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

default-terminal terminal

escape_time: Option<usize>

escape-time time

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

editor shell-command

exit_empty: Option<Switch>

exit-empty [on | off]

exit_unattached: Option<Switch>

exit-unattached [on | off]

extended_keys: Option<Switch>

extended-keys [on | off]

focus_events: Option<Switch>

focus-events [on | off]

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

history-file path

message_limit: Option<usize>

message-limit number

prompt_history_limit: Option<usize>

prompt-history-limit number

set_clipboard: Option<SetClipboard>

set-clipboard [on | external | off]

terminal_features: Option<Vec<Cow<'a, str>>>

terminal-features[] string

terminal_overrides: Option<Vec<Cow<'a, str>>>

terminal-overrides[] string

user_keys: Option<Vec<Cow<'a, str>>>

user-keys[] key

user_options: HashMap<String, Option<Cow<'a, str>>>

@user-option-name value

Implementations

impl<'a> ServerOptions<'a>

pub fn new() -> Self

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

Manual

tmux ^3.1:

backspace key

pub fn buffer_limit(self, buffer_limit: Option<usize>) -> Self

Manual

tmux ^1.5:

buffer-limit number

pub fn command_alias<I, S>(self, command_alias: Option<I>) -> Self

where I: IntoIterator<Item = S>, S: Into<Cow<'a, str>>,

Manual

tmux ^2.4:

command-alias[] name=value

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

Manual

tmux ^3.2:

copy-command shell-command

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

Manual

tmux ^2.1:

default-terminal terminal

pub fn escape_time(self, escape_time: Option<usize>) -> Self

Manual

tmux ^1.2:

escape-time time

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

Manual

tmux ^3.2:

editor shell-command

pub fn exit_empty(self, exit_empty: Option<Switch>) -> Self

Manual

tmux ^2.7:

exit-empty [on | off]

pub fn exit_unattached(self, exit_unattached: Option<Switch>) -> Self

Manual

tmux ^1.4:

exit-unattached [on | off]

pub fn extended_keys(self, extended_keys: Option<Switch>) -> Self

Manual

tmux ^3.2:

extended-keys [on | off]

pub fn focus_events(self, focus_events: Option<Switch>) -> Self

Manual

tmux ^1.9:

focus-events [on | off]

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

Manual

tmux ^2.1:

history-file path

pub fn message_limit(self, message_limit: Option<usize>) -> Self

Manual

tmux ^2.0:

message-limit number

pub fn prompt_history_limit(self, prompt_history_limit: Option<usize>) -> Self

Manual

tmux ^3.3:

prompt-history-limit number

pub fn set_clipboard(self, set_clipboard: Option<SetClipboard>) -> Self

Manual

tmux ^1.5:

set-clipboard [on | external | off]

pub fn terminal_features<I, S>(self, terminal_features: Option<I>) -> Self

where I: IntoIterator<Item = S>, S: Into<Cow<'a, str>>,

Manual

tmux ^3.2:

terminal-features[] string

pub fn terminal_overrides<I, S>(self, terminal_overrides: Option<I>) -> Self

where I: IntoIterator<Item = S>, S: Into<Cow<'a, str>>,

Manual

tmux ^2.0:

terminal-overrides[] string

pub fn user_keys<I, S>(self, user_keys: Option<I>) -> Self

where I: IntoIterator<Item = S>, S: Into<Cow<'a, str>>,

Manual

tmux ^3.0:

user-keys[] key

Trait Implementations

impl<'a> Clone for ServerOptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ServerOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ServerOptions<'a>

fn default() -> ServerOptions<'a>

Returns the “default value” for a type.

impl<'a> Display for ServerOptions<'a>

tmux show-options -g -s

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

Formats the value using the given formatter.

impl<'a> FromStr for ServerOptions<'a>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> PartialEq for ServerOptions<'a>

fn eq(&self, other: &ServerOptions<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for ServerOptions<'a>