Struct tmux_interface::commands::windows_and_panes::capture_pane::CapturePane

pub struct CapturePane<'a>(pub TmuxCommand<'a>);

Manual

tmux ^3.1:

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

tmux ^2.4:

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

tmux ^1.8:

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

tmux ^1.5:

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

tmux ^1.2:

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

Tuple Fields

0: TmuxCommand<'a>

Implementations

impl<'a> CapturePane<'a>

pub fn new() -> Self

pub fn alternate_screen(&mut self) -> &mut Self

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

pub fn escape_sequences(&mut self) -> &mut Self

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

pub fn stdout(&mut self) -> &mut Self

[-p] - the output goes to stdout

pub fn pane(&mut self) -> &mut Self

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

pub fn quite(&mut self) -> &mut Self

[-q] - quite

pub fn escape_non_printable(&mut self) -> &mut Self

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

pub fn join(&mut self) -> &mut Self

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

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

[-b buffer-name] - buffer-name

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

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

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

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

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

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

pub fn output(&self) -> Result<TmuxOutput, Error>

Trait Implementations

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

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

Returns a copy 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() -> Self

Returns the “default value” for a type.

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

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

Performs the conversion.

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

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

Performs the conversion.