Struct Cell

pub struct Cell {
    pub fg: Color,
    pub bg: Color,
    pub underline_color: Color,
    pub modifier: Modifier,
    pub skip: bool,
    /* private fields */
}

A buffer cell

Fields

fg: Color

The foreground color of the cell.

bg: Color

The background color of the cell.

underline_color: Color

The underline color of the cell.

modifier: Modifier

The modifier of the cell.

skip: bool

Whether the cell should be skipped when copying (diffing) the buffer to the screen.

Implementations

impl Cell

pub const EMPTY: Self = _

An empty Cell

pub const fn new(symbol: &'static str) -> Self

Creates a new Cell with the given symbol.

This works at compile time and puts the symbol onto the stack. Fails to build when the symbol doesnt fit onto the stack and requires to be placed on the heap. Use Self::default().set_symbol() in that case. See CompactString::const_new for more details on this.

pub fn symbol(&self) -> &str

Gets the symbol of the cell.

pub fn set_symbol(&mut self, symbol: &str) -> &mut Self

Sets the symbol of the cell.

pub fn set_char(&mut self, ch: char) -> &mut Self

Sets the symbol of the cell to a single character.

pub fn set_fg(&mut self, color: Color) -> &mut Self

Sets the foreground color of the cell.

pub fn set_bg(&mut self, color: Color) -> &mut Self

Sets the background color of the cell.

pub fn set_style<S: Into<Style>>(&mut self, style: S) -> &mut Self

Sets the style of the cell.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

pub const fn style(&self) -> Style

Returns the style of the cell.

pub fn set_skip(&mut self, skip: bool) -> &mut Self

Sets the cell to be skipped when copying (diffing) the buffer to the screen.

This is helpful when it is necessary to prevent the buffer from overwriting a cell that is covered by an image from some terminal graphics protocol (Sixel / iTerm / Kitty …).

pub fn reset(&mut self)

Resets the cell to the empty state.

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cell

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

Formats the value using the given formatter.

impl Default for Cell

fn default() -> Self

Returns the “default value” for a type.

impl From<char> for Cell

fn from(ch: char) -> Self

Converts to this type from the input type.

impl Hash for Cell

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Cell

fn eq(&self, other: &Cell) -> 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 Eq for Cell

impl StructuralPartialEq for Cell