Struct ScrollBuffer 

pub struct ScrollBuffer { /* private fields */ }

Ring buffer for storing lines with scrollback.

The scroll buffer maintains a fixed number of lines in memory, automatically discarding old lines when capacity is exceeded.

Implementations

impl ScrollBuffer

pub fn new(max_lines: usize) -> Self

Create a new scroll buffer with the given capacity.

pub fn len(&self) -> usize

Get the total number of lines in the buffer.

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

pub fn current_line(&self) -> &StyledLine

Get the current line (the line being appended to).

Panics

Panics if the buffer is empty (which should never happen).

pub fn current_line_mut(&mut self) -> &mut StyledLine

Get a mutable reference to the current line.

Panics

Panics if the buffer is empty (which should never happen).

pub fn append(&mut self, cells: impl IntoIterator<Item = Cell>)

Append cells to the current line.

pub fn newline(&mut self, wrapped: bool)

Start a new line.

Arguments

• wrapped - Whether the new line is due to soft wrapping.

pub fn get(&self, index: usize) -> Option<&StyledLine>

Get a line by index from the top of the buffer.

pub fn visible_lines( &self, viewport_height: usize, ) -> impl Iterator<Item = &StyledLine>

Get visible lines for a given viewport height.

Returns an iterator over lines that should be visible, accounting for scroll offset.

pub fn scroll_up(&mut self, lines: usize)

Scroll up by the given number of lines.

pub const fn scroll_down(&mut self, lines: usize)

Scroll down by the given number of lines.

pub const fn scroll_to_bottom(&mut self)

Scroll to the bottom (latest content).

pub const fn at_bottom(&self) -> bool

Check if we’re scrolled to the bottom.

pub fn clear(&mut self)

Clear all content.

pub fn current_line_len(&self) -> usize

Get the length of the current line in characters.

Trait Implementations

impl Debug for ScrollBuffer

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

Formats the value using the given formatter.