Struct JoinPane

pub struct JoinPane<'a> {
    pub left_above: bool,
    pub detached: bool,
    pub full_size: bool,
    pub horizontal: bool,
    pub vertical: bool,
    pub size: Option<&'a PaneSize>,
    pub src_pane: Option<Cow<'a, str>>,
    pub dst_pane: Option<Cow<'a, str>>,
}

Like split-window, but instead of splitting dst-pane and creating a new pane, split it and move src-pane into the space

Manual

tmux ^3.1:

join-pane [-bdfhv] [-l size] [-s src-pane] [-t dst-pane]
(alias: joinp)

tmux ^1.7:

join-pane [-bdhv] [-l size | -p percentage] [-s src-pane] [-t dst-pane]
(alias: joinp)

tmux ^1.2:

join-pane [-dhv] [-l size | -p percentage] [-s src-pane] [-t dst-pane]
(alias: joinp)

Fields

left_above: bool

[-b] - cause src-pane to be joined to left of or above dst-pane

detached: bool

[-d] -

full_size: bool

[-f] - creates a new pane spanning the full window height/width

horizontal: bool

[-h] - full height

vertical: bool

[-v] - full width

size: Option<&'a PaneSize>

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

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

[-s src-pane] - src-pane

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

[-t dst-pane] - dst-pane

Implementations

impl<'a> JoinPane<'a>

pub fn new() -> Self

pub fn left_above(self) -> Self

[-b] - cause src-pane to be joined to left of or above dst-pane

pub fn detached(self) -> Self

[-d] -

pub fn full_size(self) -> Self

[-f] - creates a new pane spanning the full window height/width

pub fn horizontal(self) -> Self

[-h] - full height

pub fn vertical(self) -> Self

[-v] - full width

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

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

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

[-s src-pane] - src-pane

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

[-t dst-pane] - dst-pane

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

Trait Implementations

impl<'a> Clone for JoinPane<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for JoinPane<'a>

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

Formats the value using the given formatter.

impl<'a> Default for JoinPane<'a>

fn default() -> JoinPane<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

Restrict a value to a certain interval.

impl<'a> PartialEq for JoinPane<'a>

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Eq for JoinPane<'a>

impl<'a> StructuralPartialEq for JoinPane<'a>