Struct TextBuffer 

pub struct TextBuffer { /* private fields */ }

A Buffer paired with a text-width policy.

Construct one with new, choose the width policy with with_width_mode / with_eaw_wide, paint with the TextSurface/SurfaceMut methods, then serialize with the Encode trait.

Implementations

impl TextBuffer

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

Create a width by height text buffer of blank cells.

The width policy defaults to WidthMode::Wc with East-Asian Ambiguous characters measured as one cell.

pub fn with_width_mode(self, mode: WidthMode) -> Self

Set the grapheme-cluster width policy and return the updated buffer.

pub fn with_eaw_wide(self, eaw_wide: bool) -> Self

Set the East-Asian Ambiguous policy and return the updated buffer.

When true, code points whose East-Asian-Width property is Ambiguous are measured as two cells instead of one.

pub fn set_width_mode(&mut self, mode: WidthMode)

Set the grapheme-cluster width policy in place.

pub fn set_eaw_wide(&mut self, eaw_wide: bool)

Set the East-Asian Ambiguous policy in place.

pub fn width(&self) -> u16

The width in cells.

pub fn height(&self) -> u16

The height in cells.

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

Resize the buffer, preserving overlapping cells.

pub fn buffer(&self) -> &Buffer

Borrow the underlying Buffer.

pub fn buffer_mut(&mut self) -> &mut Buffer

Mutably borrow the underlying Buffer.

pub fn into_buffer(self) -> Buffer

Consume the text buffer and return the underlying Buffer.

Trait Implementations

impl Bounded for TextBuffer

fn bounds(&self) -> Rect

Return the valid region in this value’s own coordinate space.

fn width(&self) -> u16

Return the width of Self::bounds in terminal cell columns.

fn height(&self) -> u16

Return the height of Self::bounds in terminal cell rows.

fn contains(&self, pos: Position) -> bool

Test whether a position lies inside Self::bounds.

impl Clone for TextBuffer

fn clone(&self) -> TextBuffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextBuffer

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

Formats the value using the given formatter.

impl Surface for TextBuffer

fn cell(&self, pos: Position) -> Option<&Cell>

Read the cell at a position.

fn draw<T: SurfaceMut + ?Sized>(&self, target: &mut T, at: Position)

Copy self’s cells into target, mapping the top-left of self.bounds() to at in target coordinates.

impl SurfaceMut for TextBuffer

fn set_cell(&mut self, pos: Position, cell: &Cell)

Place cell at pos. Implementations are responsible for wide-cell semantics (continuation markers, blanking covered cells) and any dirty tracking they care to do. Taking &Cell lets implementations skip the clone when the destination already matches.

fn cell_mut(&mut self, pos: Position) -> Option<&mut Cell>

Mutable handle to the cell at pos. Returns None for out-of-bounds positions.

fn fill(&mut self, cell: &Cell)

Fill the entire surface bounds with cell.

fn fill_rect(&mut self, rect: Rect, cell: &Cell)

Fill the intersection of rect and Bounded::bounds with cell.

fn clear(&mut self)

Clear the entire surface bounds to Cell::BLANK.

fn clear_rect(&mut self, rect: Rect)

Clear a rectangle to Cell::BLANK.

fn insert_lines(&mut self, y: u16, n: u16, bounds_bottom: u16, fill: &Cell)

Insert n blank rows at y, pushing existing rows down within [y, bounds_bottom). Rows pushed past bounds_bottom are lost. Freed top rows are filled with fill.

fn delete_lines(&mut self, y: u16, n: u16, bounds_bottom: u16, fill: &Cell)

Delete n rows at y, pulling existing rows up within [y, bounds_bottom). The bottom n rows of the window are filled with fill.

fn insert_cells( &mut self, pos: Position, n: u16, bounds_right: u16, fill: &Cell, )

Insert n blank cells at pos, pushing cells in [pos.x, bounds_right) right within row pos.y. Cells pushed past bounds_right are lost. The freed slots [pos.x, pos.x + n) are filled with fill.

fn delete_cells( &mut self, pos: Position, n: u16, bounds_right: u16, fill: &Cell, )

Delete n cells at pos, pulling cells in [pos.x + n, bounds_right) left within row pos.y. The freed slots [bounds_right - n, bounds_right) are filled with fill.

impl TextSurface for TextBuffer

fn width_mode(&self) -> WidthMode

Return the width-measurement mode used when shaping strings.

fn eaw_wide(&self) -> bool

Return the East-Asian Ambiguous width policy for this surface.

fn set_str( &mut self, pos: impl Into<Position>, s: &str, style: impl Into<Style>, ) -> Position

Paint s at pos, clipped to the surface bounds.

fn set_str_wrap( &mut self, pos: impl Into<Position>, s: &str, wrap: WrapMode, style: impl Into<Style>, ) -> Position

Paint s at pos with an explicit right-edge behavior.

fn set_str_rect( &mut self, rect: impl Into<Rect>, s: &str, style: impl Into<Style>, ) -> Position

Paint s inside rect, clipped to the surface bounds.

fn set_str_rect_wrap( &mut self, rect: impl Into<Rect>, s: &str, wrap: WrapMode, style: impl Into<Style>, ) -> Position

Paint s inside rect with an explicit right-edge behavior.

fn set_str_truncate( &mut self, pos: impl Into<Position>, s: &str, tail: &str, tail_style: impl Into<Style>, ) -> Position

Paint s at pos, truncating with a tail indicator on overflow.

fn set_str_rect_truncate( &mut self, rect: impl Into<Rect>, s: &str, tail: &str, tail_style: impl Into<Style>, ) -> Position

Paint s inside rect, truncating with a tail indicator on overflow.

fn str_width(&self, s: &str) -> u16

Measure the display width of s in terminal columns.

fn grapheme_width(&self, g: &str) -> u8

Measure one extended grapheme cluster in cells under this surface’s width mode and East-Asian Ambiguous policy.

fn grapheme_cells<'a>(&self, s: &'a str) -> impl Iterator<Item = (&'a str, u8)>

Iterate s as (cluster, width) pairs under this surface’s width mode and East-Asian Ambiguous policy.