Struct Buffer 

pub struct Buffer { /* private fields */ }

A buffer holding the terminal state

Implementations

impl Buffer

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

Create a new buffer with the given dimensions

Panics

Panics if:

• Width exceeds MAX_BUFFER_DIMENSION (16384)
• Height exceeds MAX_BUFFER_DIMENSION (16384)
• Total size (width * height) exceeds MAX_BUFFER_SIZE (10,000,000 cells)

Use Buffer::try_new() for a non-panicking version.

pub fn try_new(width: u16, height: u16) -> Result<Self, BufferError>

Try to create a new buffer with the given dimensions

Returns Ok(buffer) if dimensions are valid, Err(BufferError) otherwise.

Errors

Returns BufferError if:

• Width exceeds MAX_BUFFER_DIMENSION (16384)
• Height exceeds MAX_BUFFER_DIMENSION (16384)
• Total size (width * height) exceeds MAX_BUFFER_SIZE (10,000,000 cells)

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

Get a cell at position

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

Get a mutable cell at position

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

Get a slice of cells for a given row

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

Set a cell at position

pub fn set_fg(&mut self, x: u16, y: u16, fg: Color)

Set foreground color at position

pub fn set_bg(&mut self, x: u16, y: u16, bg: Color)

Set background color at position

pub fn set_colors(&mut self, x: u16, y: u16, fg: Color, bg: Color)

Set both foreground and background colors at position

pub fn put_str(&mut self, x: u16, y: u16, s: &str) -> u16

Put a string at position, handling wide characters correctly

pub fn put_str_styled( &mut self, x: u16, y: u16, s: &str, fg: Option<Color>, bg: Option<Color>, ) -> u16

Put a styled string at position

pub fn fill(&mut self, x: u16, y: u16, width: u16, height: u16, cell: Cell)

Fill a rectangular area with a cell

Optimized using slice operations for better performance.

pub fn fill_char(&mut self, x: u16, y: u16, width: u16, height: u16, ch: char)

Fill area with a character

pub fn clear(&mut self)

Clear the buffer

Optimized using slice::fill with default cell.

pub fn resize(&mut self, width: u16, height: u16)

Resize the buffer, keeping content where possible

Optimized using slice copy operations for better performance.

pub fn width(&self) -> u16

Get buffer width

pub fn height(&self) -> u16

Get buffer height

pub fn cells(&self) -> &[Cell]

Get all cells

pub fn iter_cells(&self) -> impl Iterator<Item = (u16, u16, &Cell)>

Iterate over cells with positions

pub fn register_hyperlink(&mut self, url: impl Into<String>) -> u16

Register a hyperlink URL and return its ID

pub fn get_hyperlink(&self, id: u16) -> Option<&str>

Get hyperlink URL by ID

pub fn hyperlinks(&self) -> &[String]

Get all registered hyperlinks

pub fn clear_hyperlinks(&mut self)

Clear hyperlinks (call on buffer clear/resize)

pub fn put_hyperlink( &mut self, x: u16, y: u16, text: &str, url: &str, fg: Option<Color>, bg: Option<Color>, ) -> u16

Put a hyperlinked string at position

pub fn register_sequence(&mut self, seq: impl Into<String>) -> u16

Register an escape sequence and return its ID

Used for raw terminal sequences like OSC 66 (text sizing). The sequence will be written directly to the terminal instead of the cell’s symbol.

pub fn get_sequence(&self, id: u16) -> Option<&str>

Get escape sequence by ID

pub fn sequences(&self) -> &[String]

Get all registered sequences

pub fn clear_sequences(&mut self)

Clear sequences (call on buffer clear/resize)

pub fn put_sequence( &mut self, x: u16, y: u16, seq: &str, width: u16, height: u16, )

Put an escape sequence at position, marking subsequent cells as continuations

Arguments

• x, y - Starting position
• seq - The escape sequence to write
• width - Number of cells this sequence spans (for continuation markers)
• height - Number of rows this sequence spans

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.