Struct Buffer 

pub struct Buffer {
    pub area: Rect,
    pub content: Vec<Cell>,
}

A two-dimensional grid of terminal cells.

The buffer is the primary rendering target. Widgets write into a buffer, and the terminal backend diffs the current buffer against the previous frame to compute minimal screen updates.

Fields

area: Rect

content: Vec<Cell>

Implementations

impl Buffer

pub fn empty(area: Rect) -> Self

Create a new buffer filled with empty cells.

pub fn with_lines<'a>(lines: impl IntoIterator<Item = &'a str>) -> Self

Create a buffer filled with a specific string (for testing).

pub fn reset(&mut self)

Reset all cells to empty.

pub fn resize(&mut self, area: Rect)

Resize the buffer (discards content).

pub fn cell(&self, pos: Position) -> Option<&Cell>

Get the cell at (x, y), if within bounds.

pub fn cell_mut(&mut self, pos: Position) -> Option<&mut Cell>

Get a mutable reference to the cell at (x, y).

pub fn set_string(&mut self, x: u16, y: u16, string: &str, style: Style) -> u16

Set a string starting at (x, y) with the given style. Returns the number of columns consumed.

pub fn set_string_truncated( &mut self, x: u16, y: u16, string: &str, max_width: u16, style: Style, ) -> u16

Set a string with a maximum width, truncating if necessary.

pub fn set_line(&mut self, x: u16, y: u16, line: &Line, max_width: u16) -> u16

Set a styled line at position.

pub fn set_span(&mut self, x: u16, y: u16, span: &Span, max_width: u16) -> u16

Set a single span at position with a maximum width.

pub fn set_style(&mut self, area: Rect, style: Style)

Fill an area with a style (without changing symbols).

pub fn fill(&mut self, area: Rect, symbol: &str, style: Style)

Fill an area with a character and style.

pub fn diff<'a>(&'a self, other: &'a Buffer) -> Vec<(u16, u16, &'a Cell)>

Compute the diff between this buffer and another. Returns an iterator of (x, y, &Cell) for cells that differ.

pub fn merge(&mut self, other: &Buffer)

Merge another buffer on top of this one at its area position.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the “default value” for a type.

impl Index<(u16, u16)> for Buffer

type Output = Cell

The returned type after indexing.

fn index(&self, (x, y): (u16, u16)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<(u16, u16)> for Buffer

fn index_mut(&mut self, (x, y): (u16, u16)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for Buffer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Buffer

impl StructuralPartialEq for Buffer