Struct tmux_interface::commands::windows_and_panes::split_window::SplitWindow

pub struct SplitWindow<'a> {

    pub before: bool,
    pub detached: bool,
    pub full: bool,
    pub horizontal: bool,
    pub stdin_forward: bool,
    pub vertical: bool,
    pub print: bool,
    pub zoom: bool,
    pub start_directory: Option<Cow<'a, str>>,
    pub environment: Option<Cow<'a, str>>,
    pub size: Option<&'a PaneSize>,
    pub format: Option<Cow<'a, str>>,
    pub target_pane: Option<Cow<'a, str>>,
    pub target_window: Option<Cow<'a, str>>,
    pub shell_command: Option<Cow<'a, str>>,
}

Create a new pane by splitting target-pane

Manual

tmux ^3.2:

split-window [-bdfhIvPZ] [-c start-directory] [-e environment] [-l size] [-t target-pane]
[shell-command] [-F format]
(alias: splitw)

tmux ^3.1:

split-window [-bdfhIvP] [-c start-directory] [-e environment] [-l size] [-t target-pane]
[shell-command] [-F format]
(alias: splitw)

tmux ^3.0:

split-window [-bdfhIvP] [-c start-directory] [-e environment] [-l size | -p percentage]
[-t target-pane] [shell-command] [-F format]
(alias: splitw)

tmux ^2.4:

split-window [-bdfhvP] [-c start-directory] [-l size | -p percentage] [-t target-pane]
[shell-command] [-F format]
(alias: splitw)

tmux ^2.0:

split-window [-bdhvP] [-c start-directory] [-l size | -p percentage] [-t target-pane]
[shell-command] [-F format]
(alias: splitw)

tmux ^1.7:

split-window [-dhvP] [-c start-directory] [-l size | -p percentage] [-t target-pane]
[shell-command] [-F format]
(alias: splitw)

tmux ^1.5:

split-window [-dhvP] [-l size | -p percentage] [-t target-pane] [shell-command]
(alias: splitw)

tmux ^1.2:

split-window [-dhv] [-l size | -p percentage] [-t target-pane] [shell-command]
(alias: splitw)

tmux ^1.0:

split-window [-dhv] [-l size | -p percentage] [-t target-window] [command]
(alias: splitw)

tmux ^0.8:

split-window [-d] [-l size | -p percentage] [-t target-window] [command]
(alias: splitw)

Fields

before: bool

[-b] - cause the new pane to be created to the left of or above target-pane

detached: bool

[-d] - do not make the new window the current window

full: bool

[-f] - creates a new pane spanning the full window size (h, v)

horizontal: bool

[-h] - horizontal split

stdin_forward: bool

[-I] - create an empty pane and forward any output from stdin to it

vertical: bool

[-v] - vertical split

print: bool

[-P] - print information about the new window after it has been created

zoom: bool

[-Z] - print information about the new window after it has been created

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

[-c start_directory] - start-directory

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

[-e environment] - environment

size: Option<&'a PaneSize>

[-l size] - specify the size of the new pane in lines [-l size | -p percentage] - specify the size of the new pane in lines

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

[-F format] - format

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

[-t target-pane] -

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

[-t target-window] -

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

[shell-command] - shell-command

Implementations

impl<'a> SplitWindow<'a>

pub fn new() -> Self

pub fn before(self) -> Self

[-b] - cause the new pane to be created to the left of or above target-pane

pub fn detached(self) -> Self

[-d] - do not make the new window the current window

pub fn full(self) -> Self

[-f] - creates a new pane spanning the full window size (h, v)

pub fn horizontal(self) -> Self

[-h] - horizontal split

pub fn stdin_forward(self) -> Self

[-I] - create an empty pane and forward any output from stdin to it

pub fn vertical(self) -> Self

[-v] - vertical split

pub fn print(self) -> Self

[-P] - print information about the new window after it has been created

pub fn zoom(self) -> Self

[-Z] - zooms if the window is not zoomed, or keeps it zoomed if already zoomed

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

[-c start_directory] - start-directory

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

[-e environment] - environment

pub fn size(self, size: &'a PaneSize) -> Self

[-l size] - specify the size of the new pane in lines [-l size | -p percentage] - specify the size of the new pane in lines

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

[-t target-pane] -

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

[-F format] - format

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

[-t target-window] -

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

[shell-command] - shell-command

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

Trait Implementations

impl<'a> Clone for SplitWindow<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SplitWindow<'a>

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

Formats the value using the given formatter.

impl<'a> Default for SplitWindow<'a>

fn default() -> SplitWindow<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<'a> Hash for SplitWindow<'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 SplitWindow<'a>

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

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

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

impl<'a> StructuralPartialEq for SplitWindow<'a>