Struct Buffer 

pub struct Buffer {
    pub width: u16,
    pub height: u16,
    /* private fields */
}

A 2D buffer of cells representing the terminal screen.

Fields

width: u16

height: u16

Implementations

impl Buffer

pub fn new(width: u16, height: u16) -> Self

Create a new buffer filled with empty cells.

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

Get a cell at a position.

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

Set a cell at a position.

pub fn set(&mut self, x: u16, y: u16, ch: char, fg: Color, bg: Color)

Set a character at a position with colors.

Examples found in repository

examples/38_custom_widget.rs (line 102)

    fn render(&self, area: Rect, buf: &mut Buffer) {
        for y in 0..GRID_H.min(area.height as usize) {
            for x in 0..GRID_W.min(area.width as usize) {
                let ch = if self.grid[y][x] { '\u{2588}' } else { '\u{00B7}' };
                let fg = if self.grid[y][x] { Color::Green } else { Color::DarkGrey };
                buf.set(area.x + x as u16, area.y + y as u16, ch, fg, Color::Reset);
            }
        }
    }

pub fn write_str(&mut self, x: u16, y: u16, s: &str, fg: Color, bg: Color)

Write a string at a position, clipping at buffer boundaries.

Handles grapheme clusters and wide characters (CJK, emoji) properly:

• Iterates by grapheme clusters (user-perceived characters)
• Wide characters (display width 2) advance the column by 2
• Wide char continuations are marked so the renderer can skip them

Examples found in repository

examples/37_error_boundary.rs (line 27)

    fn render(&self, area: Rect, buf: &mut Buffer) {
        assert!(self.0 < 5, "Counter hit 5 — boom!");
        let text = format!("Counter: {} (panics at 5)", self.0);
        buf.write_str(area.x, area.y, &text, Color::Green, Color::Reset);
    }

pub fn write_str_styled( &mut self, x: u16, y: u16, s: &str, fg: Color, bg: Color, bold: bool, italic: bool, underline: bool, dim: bool, )

Write a styled string at a position, clipping at buffer boundaries.

Handles grapheme clusters and wide characters (CJK, emoji) properly:

• Iterates by grapheme clusters (user-perceived characters)
• Wide characters (display width 2) advance the column by 2
• Wide char continuations are marked so the renderer can skip them

pub fn rect(&self) -> Rect

Get the full rect of this buffer.

pub fn clear(&mut self)

Clear the buffer to empty cells.

pub fn fill(&mut self, fg: Color, bg: Color)

Fill the buffer with a specific foreground and background color.

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

Compute the differences between this buffer and another. Returns a list of (x, y, cell) for cells that differ.

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 Display for Buffer

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

Formats the value using the given formatter.