Struct CapturePaneRequest 

pub struct CapturePaneRequest {

    pub target: PaneTarget,
    pub start: Option<i64>,
    pub end: Option<i64>,
    pub print: bool,
    pub buffer_name: Option<String>,
    pub alternate: bool,
    pub escape_ansi: bool,
    pub escape_sequences: bool,
    pub include_format: bool,
    pub hyperlinks: bool,
    pub line_numbers: bool,
    pub join_wrapped: bool,
    pub use_mode_screen: bool,
    pub preserve_trailing_spaces: bool,
    pub do_not_trim_spaces: bool,
    pub pending_input: bool,
    pub quiet: bool,
    pub start_is_absolute: bool,
    pub end_is_absolute: bool,
}

Request payload for capture-pane.

Fields

target: PaneTarget

The pane whose retained transcript should be captured.

start: Option<i64>

The optional inclusive start line.

end: Option<i64>

The optional inclusive end line.

print: bool

Whether to print captured bytes to stdout instead of writing a buffer.

buffer_name: Option<String>

The optional destination buffer name for non-printing captures.

alternate: bool

Whether the saved alternate-screen copy should be captured.

escape_ansi: bool

Whether ANSI SGR and hyperlink sequences should be preserved.

escape_sequences: bool

Whether control sequences should be octal-escaped.

include_format: bool

Whether each captured line should be prefixed with tmux line flags.

hyperlinks: bool

Whether hyperlink information should be captured instead of text.

line_numbers: bool

Whether each captured line should be prefixed with its line number.

join_wrapped: bool

Whether wrapped rows should be joined without intervening newlines.

use_mode_screen: bool

Whether the copy-mode screen should be captured when present.

preserve_trailing_spaces: bool

Whether trailing spaces should be preserved.

do_not_trim_spaces: bool

Whether trailing spaces should not be trimmed.

pending_input: bool

Whether pending parser bytes should be captured instead of the screen grid.

quiet: bool

Whether missing alternate-screen content should be silenced.

start_is_absolute: bool

Whether -S - was used.

end_is_absolute: bool

Whether -E - was used.

Trait Implementations

impl Clone for CapturePaneRequest

fn clone(&self) -> CapturePaneRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapturePaneRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapturePaneRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CapturePaneRequest

impl PartialEq for CapturePaneRequest

fn eq(&self, other: &CapturePaneRequest) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CapturePaneRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapturePaneRequest