Struct ScreenBuffer 

pub struct ScreenBuffer { /* private fields */ }

A 2D grid of terminal cells representing one frame of terminal content.

Implementations

impl ScreenBuffer

pub fn new(size: Size) -> Self

Create a new screen buffer filled with blank cells.

pub fn size(&self) -> Size

Get the buffer dimensions.

pub fn width(&self) -> u16

Get the buffer width.

pub fn height(&self) -> u16

Get the buffer height.

pub fn clear(&mut self)

Clear the buffer, resetting all cells to blank.

pub fn resize(&mut self, size: Size)

Resize the buffer. Contents are lost (filled with blanks).

pub fn get(&self, x: u16, y: u16) -> Option<&Cell>

Get a reference to the cell at (x, y), or None if out of bounds.

pub fn get_mut(&mut self, x: u16, y: u16) -> Option<&mut Cell>

Get a mutable reference to the cell at (x, y), or None if out of bounds.

pub fn set(&mut self, x: u16, y: u16, cell: Cell)

Set a cell at (x, y). If the cell is wide (width > 1), the next cell is automatically set to a continuation cell. No-op if out of bounds.

This method handles wide character edge cases:

• If writing over a continuation cell, the preceding wide character’s primary cell is blanked to avoid leaving a half-rendered glyph.
• If writing over a wide character’s primary cell, the old continuation cell at x+1 is blanked.
• If a wide character would place its continuation cell beyond the last column, the wide character is replaced with a single space instead.

pub fn get_row(&self, y: u16) -> Option<&[Cell]>

Get a row of cells as a slice.

pub fn diff(&self, previous: &ScreenBuffer) -> Vec<CellChange>

Compute the differences between this buffer and a previous buffer. Returns a list of cell changes needed to update the terminal.

Trait Implementations

impl Clone for ScreenBuffer

fn clone(&self) -> ScreenBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenBuffer

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

Formats the value using the given formatter.