Struct Frame 

pub struct Frame {

    pub cols: u16,
    pub rows: u16,
    pub kind: FrameKind,
    pub cursor_row: u16,
    pub cursor_col: u16,
    pub cursor_visible: bool,
    pub cursor_shape: CursorShape,
    pub cursor_blink: bool,
    pub display_offset: u32,
    pub scrollback_len: u32,
    pub mouse_events: MouseEvents,
    pub alt_screen: bool,
    pub scroll: Option<ScrollOp>,
    pub spans: Vec<Span>,
    pub link_table: Vec<String>,
    pub overlay: Overlay,
}

One serialized damage cycle: the decoded logical form that encode/decode round-trip. link_table holds this frame’s OSC 8 hyperlink URIs, each shipped once and referenced by Span::links. Grapheme clusters have no table — since v14 (#621) they are inlined at their column in Span::combining, because nothing interned them and the table only bought an index to overflow.

Fields

cols: u16

rows: u16

kind: FrameKind

cursor_row: u16

Cursor row/col in screen coordinates (0-based), and whether the engine shows it (DECTCEM). Rides in the header because the cursor moves with almost every frame (#38). Drawing the cursor — cell-invert / overlay — stays the consumer’s renderer adapter; the engine only reports state.

cursor_col: u16

cursor_visible: bool

cursor_shape: CursorShape

The caret shape (DECSCUSR #89) and whether it blinks (att610 ?12, #81). Reported for the renderer; drawing/animation stays the consumer’s.

cursor_blink: bool

display_offset: u32

Viewport scroll position (#112 / ADR-0013), for the consumer’s scrollbar. display_offset = lines scrolled up from the bottom (0 = following the live screen); scrollback_len = history lines (total = + rows). Ride in the header like the cursor — per-frame viewport state, not cell content.

scrollback_len: u32

mouse_events: MouseEvents

The mouse tracking mode as a wanted-events mask (#129): which mouse event categories the app asked to receive, so the consumer routes an event to the app (bit set) or keeps it local. empty() = no reporting. Rides the header like the cursor — per-frame mode state the consumer reads, not cell content. Positions/encoding never cross; the backend encodes via encode_mouse.

alt_screen: bool

Whether the alternate screen (?1049/?47) is active (#149). Buffer-global state a frame-mode consumer can’t derive from viewport damage — the accessibility announce policy (#119) gates on it (suppress TUI repaints). Rides the header like the cursor scalars (ADR-0014).

scroll: Option<ScrollOp>

spans: Vec<Span>

link_table: Vec<String>

overlay: Overlay

Interaction overlays for this viewport (#108): selection, search highlights, the active match, and markers — see Overlay.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame