Struct SessionOptions

pub struct SessionOptions<'a> {

    pub activity_action: Option<Action>,
    pub assume_paste_time: Option<usize>,
    pub base_index: Option<usize>,
    pub bell_action: Option<Action>,
    pub default_command: Option<Cow<'a, str>>,
    pub default_shell: Option<Cow<'a, str>>,
    pub default_size: Option<(usize, usize)>,
    pub destroy_unattached: Option<DestroyUnattached>,
    pub detach_on_destroy: Option<DetachOnDestroy>,
    pub display_panes_active_colour: Option<Cow<'a, str>>,
    pub display_panes_colour: Option<Cow<'a, str>>,
    pub display_panes_time: Option<usize>,
    pub display_time: Option<usize>,
    pub history_limit: Option<usize>,
    pub key_table: Option<Cow<'a, str>>,
    pub lock_after_time: Option<usize>,
    pub lock_command: Option<Cow<'a, str>>,
    pub message_command_style: Option<Cow<'a, str>>,
    pub message_line: Option<MessageLine>,
    pub message_style: Option<Cow<'a, str>>,
    pub mouse: Option<Switch>,
    pub prefix: Option<Cow<'a, str>>,
    pub prefix2: Option<Cow<'a, str>>,
    pub renumber_windows: Option<Switch>,
    pub repeat_time: Option<usize>,
    pub set_titles: Option<Switch>,
    pub set_titles_string: Option<Cow<'a, str>>,
    pub silence_action: Option<Action>,
    pub status: Option<Status>,
    pub status_format: Option<Vec<Cow<'a, str>>>,
    pub status_interval: Option<usize>,
    pub status_justify: Option<StatusJustify>,
    pub status_keys: Option<StatusKeys>,
    pub status_left: Option<Cow<'a, str>>,
    pub status_left_length: Option<usize>,
    pub status_left_style: Option<Cow<'a, str>>,
    pub status_position: Option<StatusPosition>,
    pub status_right: Option<Cow<'a, str>>,
    pub status_right_length: Option<usize>,
    pub status_right_style: Option<Cow<'a, str>>,
    pub status_style: Option<Cow<'a, str>>,
    pub update_environment: Option<Vec<Cow<'a, str>>>,
    pub visual_activity: Option<Activity>,
    pub visual_bell: Option<Activity>,
    pub visual_silence: Option<Activity>,
    pub word_separators: Option<Cow<'a, str>>,
    pub user_options: HashMap<String, Option<Cow<'a, str>>>,
}

Fields

activity_action: Option<Action>

assume_paste_time: Option<usize>

base_index: Option<usize>

bell_action: Option<Action>

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

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

default_size: Option<(usize, usize)>

destroy_unattached: Option<DestroyUnattached>

detach_on_destroy: Option<DetachOnDestroy>

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

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

display_panes_time: Option<usize>

display_time: Option<usize>

history_limit: Option<usize>

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

lock_after_time: Option<usize>

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

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

message_line: Option<MessageLine>

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

mouse: Option<Switch>

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

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

renumber_windows: Option<Switch>

repeat_time: Option<usize>

set_titles: Option<Switch>

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

silence_action: Option<Action>

status: Option<Status>

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

status_interval: Option<usize>

status_justify: Option<StatusJustify>

status_keys: Option<StatusKeys>

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

status_left_length: Option<usize>

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

status_position: Option<StatusPosition>

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

status_right_length: Option<usize>

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

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

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

visual_activity: Option<Activity>

visual_bell: Option<Activity>

visual_silence: Option<Activity>

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

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

Implementations

impl<'a> SessionOptions<'a>

pub fn new() -> Self

pub fn activity_action(self, activity_action: Option<Action>) -> Self

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

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

pub fn bell_action(self, bell_action: Option<Action>) -> Self

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

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

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

pub fn destroy_unattached( self, destroy_unattached: Option<DestroyUnattached>, ) -> Self

pub fn detach_on_destroy( self, detach_on_destroy: Option<DetachOnDestroy>, ) -> Self

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn silence_action(self, silence_action: Option<Action>) -> Self

pub fn status(self, status: Option<Status>) -> Self

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

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

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

pub fn status_justify(self, status_justify: Option<StatusJustify>) -> Self

pub fn status_keys(self, status_keys: Option<StatusKeys>) -> Self

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

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

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

pub fn status_position(self, status_position: Option<StatusPosition>) -> Self

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

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

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

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

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

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

pub fn visual_activity(self, visual_activity: Option<Activity>) -> Self

pub fn visual_bell(self, visual_bell: Option<Activity>) -> Self

pub fn visual_silence(self, visual_silence: Option<Activity>) -> Self

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

Trait Implementations

impl<'a> Clone for SessionOptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SessionOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for SessionOptions<'a>

fn default() -> SessionOptions<'a>

Returns the “default value” for a type.

impl<'a> Display for SessionOptions<'a>

Default

tmux show-options -g

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

Formats the value using the given formatter.

impl<'a> FromStr for SessionOptions<'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 SessionOptions<'a>

fn eq(&self, other: &SessionOptions<'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 SessionOptions<'a>