Struct ScreenDiff 

#[non_exhaustive]
pub struct ScreenDiff {
    pub changes: Vec<Change>,
    pub mode: ScreenMode,
    pub size: (usize, usize),
    pub cursor: CursorPosition,
}

The constant view into the terminal, regardless of whether it’s in primary or alternate screen.

However, sending diffs of it is only possible when in “alternate mode”. This is because the diffs generated by the scrollback only apply to the ever-growing scrollback buffer. The screen on the other hand is always limited to a certain height, in which case diffs can’t just be additive, they must also replace what is under them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

changes: Vec<Change>

A list of termwiz changes that, once applied, should bring any surfaces following this view, up to date.

mode: ScreenMode

Whether the terminal screen is primary or alternate.

size: (usize, usize)

The size of the underlying PTY at the time this diff was made.

cursor: CursorPosition

All the details about the user’s cursor.

Trait Implementations

impl Clone for ScreenDiff

fn clone(&self) -> ScreenDiff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenDiff

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

Formats the value using the given formatter.

impl Default for ScreenDiff

fn default() -> ScreenDiff

Returns the “default value” for a type.