Struct tmux_interface::commands::windows_and_panes::choose_tree::ChooseTree

pub struct ChooseTree<'a> {
    pub all: bool,
    pub without_preview: bool,
    pub reverse_sort_order: bool,
    pub collapsed_sessions: bool,
    pub collapsed_windows: bool,
    pub zoom: bool,
    pub format: Option<Cow<'a, str>>,
    pub filter: Option<Cow<'a, str>>,
    pub key_format: Option<Cow<'a, str>>,
    pub sort_order: Option<Cow<'a, str>>,
    pub target_pane: Option<Cow<'a, str>>,
    pub template: Option<Cow<'a, str>>,
}

Put a pane into tree mode, where a session, window or pane may be chosen interactively from a list

Manual

tmux ^3.2:

choose-tree [-GNrswZ] [-F format] [-f filter] [-K key-format] [-O sort-order] [-t target-pane] [template]

tmux ^3.1:

choose-tree [-GNrswZ] [-F format] [-f filter] [-O sort-order] [-t target-pane] [template]

tmux ^2.7:

choose-tree [-GNswZ] [-F format] [-f filter] [-O sort-order] [-t target-pane] [template]

tmux ^2.6:

choose-tree [-Nsw] [-F format] [-f filter] [-O sort-order] [-t target-pane] [template]

tmux ^1.8:

choose-tree [-suw] [-b session-template] [-c window-template] [-S format] [-W format]
[-t target-window]

tmux ^1.7:

choose-tree [-sw] [-b session-template] [-c window-template] [-S format] [-W format]
[-t target-window]

Fields

all: bool

[-G] - include all sessions in any session groups in the tree rather than only the first

without_preview: bool

[-N] - start without the preview

reverse_sort_order: bool

[-r] - reverses the sort order

collapsed_sessions: bool

[-s] - start with collapsed sessions

collapsed_windows: bool

[-w] - start with collapsed windows

zoom: bool

[-Z] - zoom the pane

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

[-F format] - format

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

[-f filter] - filter

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

[-K key-format] - format for each shortcut key

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

[-O sort-order] - specifies the initial sort field

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

[-t target-pane] - target-pane

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

[template] - template

Implementations

impl<'a> ChooseTree<'a>

pub fn new() -> Self

pub fn all(self) -> Self

[-G] - include all sessions in any session groups in the tree rather than only the first

pub fn without_preview(self) -> Self

[-N] - start without the preview

pub fn reverse_sort_order(self) -> Self

[-r] - reverses the sort order

pub fn collapsed_sessions(self) -> Self

[-s] - start with collapsed sessions

pub fn collapsed_windows(self) -> Self

[-w] - start with collapsed windows

pub fn zoom(self) -> Self

[-Z] - zoom the pane

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

[-F format] - format

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

[-f filter] - filter

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

[-K key-format] - format for each shortcut key

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

[-O sort-order] - specifies the initial sort field

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

[-t target-pane] - target-pane

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

[template] - template

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

Trait Implementations

impl<'a> Clone for ChooseTree<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ChooseTree<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ChooseTree<'a>

fn default() -> ChooseTree<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<'a> Hash for ChooseTree<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ChooseTree<'a>

fn cmp(&self, other: &ChooseTree<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for ChooseTree<'a>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for ChooseTree<'a>

fn partial_cmp(&self, other: &ChooseTree<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for ChooseTree<'a>

impl<'a> StructuralPartialEq for ChooseTree<'a>