Struct Screen 

pub struct Screen { /* private fields */ }

A rows x cols grid of Cells plus a Cursor, both 0-based.

Implementations

impl Screen

pub fn new(rows: usize, cols: usize) -> Self

A blank screen (all default cells, cursor at the origin).

pub fn rows(&self) -> usize

pub fn cols(&self) -> usize

pub fn cursor(&self) -> Cursor

Where the cursor rests after rendering.

pub fn set_cursor(&mut self, cursor: Cursor)

Move the cursor, clamped onto the grid: a row or column past the edge lands on the last row or column (the origin on an empty screen). The renderers park the terminal cursor here.

pub fn clear(&mut self)

Reset all cells to default and the cursor to the origin, reusing the existing allocation. The caller must ensure the screen is already the right size; use Screen::new when the size changes.

pub fn cell(&self, row: usize, col: usize) -> Cell

The cell at (row, col); out of bounds returns a default cell.

pub fn set(&mut self, row: usize, col: usize, cell: Cell)

Set one cell. Out-of-bounds writes are ignored.

pub fn write_str(&mut self, row: usize, col: usize, text: &str, style: Style)

Write a string across a row starting at (row, col), truncating at the right edge. Each char takes one cell (single-width); callers that need double-width layout use Cell::wide with Screen::set or Screen::copy_cells.

pub fn copy_cells(&mut self, row: usize, col: usize, cells: &[Cell])

Copy a contiguous run of cells into row starting at column col, clipping the run at the right edge (and ignoring an out-of-range row or start column). Equivalent to calling Screen::set for each cell in turn, but with a single bounds check for the whole run — the fast path a compositor uses to blit a row slice.

pub fn diff(&self, next: &Screen) -> Vec<u8>

The bytes that transform a terminal currently showing self into one showing next: cursor moves (CUP), minimal SGR transitions, and the changed characters, ending with a style reset and the cursor parked at next’s cursor. Equal screens produce no bytes at all.

Both screens must have the same dimensions; if they differ (a resize), the diff falls back to a full repaint of next.

pub fn render_full(&self) -> Vec<u8>

A from-scratch repaint: clear the screen, then paint every non-default cell, ending with a style reset and the cursor parked at this screen’s cursor.

Trait Implementations

impl Clone for Screen

fn clone(&self) -> Screen

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Screen

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

Formats the value using the given formatter.

impl Eq for Screen

impl PartialEq for Screen

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Screen