Struct Buffer 

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

A buffer representing the terminal screen.

The buffer is a rectangular grid of Cells that can be efficiently diffed to minimize terminal updates.

Example

use tuxtui_core::buffer::Buffer;
use tuxtui_core::geometry::Rect;
use tuxtui_core::style::{Color, Style};

let mut buffer = Buffer::empty(Rect::new(0, 0, 10, 5));
buffer.set_string(0, 0, "Hello", Style::default().fg(Color::Green));

Fields

area: Rect

The area covered by this buffer

content: Vec<Cell>

The cells in this buffer (row-major order)

Implementations

impl Buffer

pub fn empty(area: Rect) -> Self

Create an empty buffer with the given area.

All cells are initialized to spaces with default style.

pub fn filled(area: Rect, cell: &Cell) -> Self

Create a buffer filled with a specific cell.

pub const fn index_of(&self, x: u16, y: u16) -> Option<usize>

Get the index into the content vector for the given coordinates.

Returns None if the coordinates are out of bounds.

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

Get a reference to the cell at the given coordinates.

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

Get a mutable reference to the cell at the given coordinates.

pub fn set( &mut self, x: u16, y: u16, symbol: impl Into<String>, style: Style, ) -> bool

Set the symbol and style of a cell at the given coordinates.

Returns true if the cell was updated, false if out of bounds.

Example

use tuxtui_core::buffer::Buffer;
use tuxtui_core::geometry::Rect;
use tuxtui_core::style::Style;

let mut buffer = Buffer::empty(Rect::new(0, 0, 10, 10));
buffer.set(5, 5, "X", Style::default());

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

Set a string at the given position with a style.

Returns the x-coordinate after the last written character.

Example

use tuxtui_core::buffer::Buffer;
use tuxtui_core::geometry::Rect;
use tuxtui_core::style::{Color, Style};

let mut buffer = Buffer::empty(Rect::new(0, 0, 20, 5));
let style = Style::default().fg(Color::Blue);
let end_x = buffer.set_string(0, 0, "Hello, world!", style);

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

Set a styled string with mixed styles (via spans).

This is used internally by text rendering.

pub fn clear(&mut self)

Clear the entire buffer.

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

Clear a specific rectangular region.

pub fn set_style(&mut self, _style: Style)

Set the style for subsequent operations (no-op for buffer).

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

Resize the buffer to a new area.

Content is preserved where it overlaps; new areas are filled with default cells.

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

Merge another buffer into this one at the specified position.

pub fn diff<'a>(&'a self, other: &'a Self) -> Vec<Diff<'a>>

Compute the differences between this buffer and another.

Returns a vector of Diff operations representing the minimal changes.

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<'de> Deserialize<'de> for Buffer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Buffer

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

Formats the value using the given formatter.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Buffer

impl StructuralPartialEq for Buffer