Struct ScreenBuffer 

pub struct ScreenBuffer { /* private fields */ }

A simple screen buffer for terminal content.

This provides basic screen buffer functionality. For full terminal emulation, use the screen feature which provides a more complete implementation.

Implementations

impl ScreenBuffer

pub fn new(dimensions: Dimensions) -> Self

Create a new screen buffer.

pub const fn dimensions(&self) -> Dimensions

Get the screen dimensions.

pub const fn cursor(&self) -> Position

Get the cursor position.

pub fn set_cursor(&mut self, pos: Position)

Set the cursor position.

pub fn move_cursor(&mut self, rows: isize, cols: isize)

Move the cursor.

pub const fn save_cursor(&mut self)

Save the cursor position.

pub const fn restore_cursor(&mut self)

Restore the cursor position.

pub fn get(&self, row: usize, col: usize) -> Option<&Cell>

Get a cell at a position.

pub fn get_mut(&mut self, row: usize, col: usize) -> Option<&mut Cell>

Get a mutable cell at a position.

pub fn put_char(&mut self, c: char, attrs: CellAttributes)

Put a character at the cursor position.

pub fn line(&self, row: usize) -> Option<String>

Get a line as a string.

pub fn lines(&self) -> Vec<String>

Get all lines as strings.

pub fn content(&self) -> String

Get the screen content as a single string.

pub fn region_text(&self, region: Region) -> String

Get text in a region.

pub fn clear(&mut self)

Clear the screen.

pub fn clear_region(&mut self, region: Region)

Clear a region.

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

Scroll the screen up by n lines.

pub fn scroll_down(&mut self, n: usize)

Scroll the screen down by n lines.

pub const fn set_scroll_region(&mut self, top: usize, bottom: usize)

Set the scroll region.

pub fn resize(&mut self, dimensions: Dimensions)

Resize the screen.

Trait Implementations

impl Debug for ScreenBuffer

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

Formats the value using the given formatter.