Struct CapturePane

pub struct CapturePane<'a> {

    pub alternate_screen: bool,
    pub escape_sequences: bool,
    pub stdout: bool,
    pub pane: bool,
    pub quiet: bool,
    pub escape_non_printable: bool,
    pub join: bool,
    pub trailing_spaces: bool,
    pub ignore_trailing_positions: bool,
    pub buffer_name: Option<Cow<'a, str>>,
    pub end_line: Option<Cow<'a, str>>,
    pub start_line: Option<Cow<'a, str>>,
    pub target_pane: Option<Cow<'a, str>>,
}

Manual

tmux ^3.4:

capture-pane [-aAepPqCJNT] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)

tmux ^3.1:

capture-pane [-aepPqCJN] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)

tmux ^2.4:

capture-pane [-aepPqCJ] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)

tmux ^1.8:

capture-pane [-aepPq] [-b buffer-name] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)

tmux ^1.5:

capture-pane [-b buffer-index] [-E end-line] [-S start-line] [-t target-pane]
(alias: capturep)

tmux ^1.2:

capture-pane [-b buffer-index] [-t target-pane]
(alias: capturep)

Fields

alternate_screen: bool

[-a] - the alternate screen is used, and the history is not accessible

escape_sequences: bool

[-e] - the output includes escape sequences for text and background attributes

stdout: bool

[-p] - the output goes to stdout

pane: bool

[-P] - capture only any output that the pane has received that is the beginning of an as-yet incomplete escape sequence

quiet: bool

[-q] - quiet

escape_non_printable: bool

[-C] - escape non-printable characters as octal \xxx

join: bool

[-J] - preserve trailing spaces and joins any wrapped lines

trailing_spaces: bool

[-N] - preserves trailing spaces at each line’s end

ignore_trailing_positions: bool

[-T] - ignores trailing positions that do not contain a character

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

[-b buffer-name] - buffer-name

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

[-E end-line] - specify the ending line number

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

[-S start-line] - specify the starting line number

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

[-t target-pane] - specify target-pane

Implementations

impl<'a> CapturePane<'a>

pub fn new() -> Self

pub fn alternate_screen(self) -> Self

[-a] - the alternate screen is used, and the history is not accessible

pub fn escape_sequences(self) -> Self

[-e] - the output includes escape sequences for text and background attributes

pub fn stdout(self) -> Self

[-p] - the output goes to stdout

pub fn pane(self) -> Self

[-P] - capture only any output that the pane has received that is the beginning of an as-yet incomplete escape sequence

pub fn quiet(self) -> Self

[-q] - quiet

pub fn escape_non_printable(self) -> Self

[-C] - escape non-printable characters as octal \xxx

pub fn join(self) -> Self

[-J] - preserve trailing spaces and joins any wrapped lines

pub fn trailing_spaces(self) -> Self

[-N] - preserves trailing spaces at each line’s end

pub fn ignore_trailing_positions(self) -> Self

[-T] - ignores trailing positions that do not contain a character

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

[-b buffer-name] - buffer-name

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

[-E end-line] - specify the ending line number

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

[-S start-line] - specify the starting line number

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

[-t target-pane] - specify target-pane

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

Trait Implementations

impl<'a> Clone for CapturePane<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CapturePane<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CapturePane<'a>

fn default() -> CapturePane<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

impl<'a> StructuralPartialEq for CapturePane<'a>