Skip to main content

WindowOptions

Struct WindowOptions 

Source
pub struct WindowOptions<'a> {
Show 31 fields pub aggressive_resize: Option<Switch>, pub automatic_rename: Option<Switch>, pub automatic_rename_format: Option<Cow<'a, str>>, pub clock_mode_colour: Option<Cow<'a, str>>, pub clock_mode_style: Option<ClockModeStyle>, pub main_pane_height: Option<usize>, pub main_pane_width: Option<usize>, pub mode_keys: Option<StatusKeys>, pub mode_style: Option<Cow<'a, str>>, pub monitor_activity: Option<Switch>, pub monitor_bell: Option<Switch>, pub monitor_silence: Option<usize>, pub other_pane_height: Option<usize>, pub other_pane_width: Option<usize>, pub pane_active_border_style: Option<Cow<'a, str>>, pub pane_base_index: Option<usize>, pub pane_border_format: Option<Cow<'a, str>>, pub pane_border_status: Option<PaneBorderStatus>, pub pane_border_style: Option<Cow<'a, str>>, pub window_status_activity_style: Option<Cow<'a, str>>, pub window_status_bell_style: Option<Cow<'a, str>>, pub window_status_current_format: Option<Cow<'a, str>>, pub window_status_current_style: Option<Cow<'a, str>>, pub window_status_format: Option<Cow<'a, str>>, pub window_status_last_style: Option<Cow<'a, str>>, pub window_status_separator: Option<Cow<'a, str>>, pub window_status_style: Option<Cow<'a, str>>, pub window_size: Option<WindowSize>, pub wrap_search: Option<Switch>, pub xterm_keys: Option<Switch>, pub user_options: HashMap<String, Option<Cow<'a, str>>>,
}

Fields§

§aggressive_resize: Option<Switch>

tmux ^1.0:

aggressive-resize [on | off]
§automatic_rename: Option<Switch>

tmux ^1.0:

automatic-rename [on | off]
§automatic_rename_format: Option<Cow<'a, str>>

tmux ^1.9:

automatic-rename-format format
§clock_mode_colour: Option<Cow<'a, str>>

tmux ^1.0:

clock-mode-colour colour
§clock_mode_style: Option<ClockModeStyle>

tmux ^1.0:

clock-mode-style [12 | 24]
§main_pane_height: Option<usize>

tmux ^1.0:

main-pane-height height
§main_pane_width: Option<usize>

tmux ^1.0:

main-pane-width width
§mode_keys: Option<StatusKeys>

tmux ^1.0:

mode-keys [vi | emacs]
§mode_style: Option<Cow<'a, str>>

tmux ^1.9:

mode-style style
§monitor_activity: Option<Switch>

tmux ^1.0:

monitor-activity [on | off]
§monitor_bell: Option<Switch>

tmux ^2.6:

monitor-bell [on | off]
§monitor_silence: Option<usize>

tmux ^1.4:

monitor-silence [interval]
§other_pane_height: Option<usize>

tmux ^1.4:

other-pane-height height
§other_pane_width: Option<usize>

tmux ^1.4:

other-pane-width width
§pane_active_border_style: Option<Cow<'a, str>>

tmux ^1.9:

pane-active-border-style style
§pane_base_index: Option<usize>

tmux ^1.6:

pane-base-index index
§pane_border_format: Option<Cow<'a, str>>

tmux ^2.3:

pane-border-format format
§pane_border_status: Option<PaneBorderStatus>

tmux ^2.3:

pane-border-status [off | top | bottom]
§pane_border_style: Option<Cow<'a, str>>

tmux ^2.0:

pane-border-style style
§window_status_activity_style: Option<Cow<'a, str>>

tmux ^1.9:

window-status-activity-style style
§window_status_bell_style: Option<Cow<'a, str>>

tmux ^1.9:

window-status-bell-style style
§window_status_current_format: Option<Cow<'a, str>>

tmux ^1.2:

window-status-current-format string
§window_status_current_style: Option<Cow<'a, str>>

tmux ^1.9:

window-status-current-style style
§window_status_format: Option<Cow<'a, str>>

tmux ^1.2:

window-status-format string
§window_status_last_style: Option<Cow<'a, str>>

tmux ^1.9:

window-status-last-style style
§window_status_separator: Option<Cow<'a, str>>

tmux ^1.7:

window-status-separator string
§window_status_style: Option<Cow<'a, str>>

tmux ^1.9:

window-status-style style
§window_size: Option<WindowSize>

tmux ^2.9:

window-size largest | smallest | manual | latest
§wrap_search: Option<Switch>

tmux ^1.7:

wrap-search [on | off]
§xterm_keys: Option<Switch>

tmux ^1.0:

 xterm-keys [on | off]
§user_options: HashMap<String, Option<Cow<'a, str>>>

tmux ^1.0:

@user-option-name value

Implementations§

Source§

impl<'a> WindowOptions<'a>

Source

pub fn new() -> Self

tmux show-options -g -w
Source§

impl<'a> WindowOptions<'a>

Source

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

Source

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

Source

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

Source

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

Source

pub fn clock_mode_style(self, clock_mode_style: Option<ClockModeStyle>) -> Self

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn pane_border_status( self, pane_border_status: Option<PaneBorderStatus>, ) -> Self

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn window_size(self, window_size: Option<WindowSize>) -> Self

Source

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

Trait Implementations§

Source§

impl<'a> Clone for WindowOptions<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for WindowOptions<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for WindowOptions<'a>

Source§

fn default() -> WindowOptions<'a>

Returns the “default value” for a type. Read more
Source§

impl<'a> Display for WindowOptions<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> FromStr for WindowOptions<'a>

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl<'a> PartialEq for WindowOptions<'a>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a> StructuralPartialEq for WindowOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for WindowOptions<'a>

§

impl<'a> RefUnwindSafe for WindowOptions<'a>

§

impl<'a> Send for WindowOptions<'a>

§

impl<'a> Sync for WindowOptions<'a>

§

impl<'a> Unpin for WindowOptions<'a>

§

impl<'a> UnsafeUnpin for WindowOptions<'a>

§

impl<'a> UnwindSafe for WindowOptions<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.