Struct ScreenCapture 

pub struct ScreenCapture {

    pub schema_version: u32,
    pub rows: u16,
    pub columns: u16,
    pub text_rows: Vec<String>,
    pub cursor_row: u16,
    pub cursor_column: u16,
    pub cursor_visible: bool,
    pub alternate_screen: bool,
    pub revision: u64,
    pub bytes_received: u64,
    pub raw_truncated: bool,
    pub parser_errors: usize,
    pub reader_error: Option<String>,
    pub status: ProcessStatus,
    pub cells: Option<Vec<CellCapture>>,
}

Typed snapshot of the current visible screen and child state.

Fields

schema_version: u32

Contract version for forwards-compatible consumers.

rows: u16

Screen row count.

columns: u16

Screen column count.

text_rows: Vec<String>

Visible rows with terminal escapes resolved.

cursor_row: u16

Cursor row.

cursor_column: u16

Cursor column.

cursor_visible: bool

Whether the cursor is visible.

alternate_screen: bool

Whether the alternate screen buffer is active.

revision: u64

Monotonic state revision.

bytes_received: u64

Total bytes received from the child.

raw_truncated: bool

Whether the bounded raw history discarded older bytes.

parser_errors: usize

VT parser error count.

reader_error: Option<String>

Reader failure, if the PTY reader ended with an error.

status: ProcessStatus

Child process status.

cells: Option<Vec<CellCapture>>

Detailed cells when a region was requested.

Trait Implementations

impl Clone for ScreenCapture

fn clone(&self) -> ScreenCapture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenCapture

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

Formats the value using the given formatter.

impl Eq for ScreenCapture

impl PartialEq for ScreenCapture

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScreenCapture

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 ScreenCapture