Skip to main content

Cell

Struct Cell 

Source
pub struct Cell {
    pub flags: CellFlags,
    pub attrs: SgrAttrs,
    pub hyperlink: HyperlinkId,
    /* private fields */
}
Expand description

A single cell in the terminal grid.

Fields§

§flags: CellFlags

Cell-level flags (wide char, continuation, etc.).

§attrs: SgrAttrs

SGR text attributes.

§hyperlink: HyperlinkId

Hyperlink ID (0 = no link).

Implementations§

Source§

impl Cell

Source

pub fn new(ch: char) -> Self

Create a new cell with the given character and default attributes.

Source

pub fn with_attrs(ch: char, width: u8, attrs: SgrAttrs) -> Self

Create a new cell with the given character, width, and attributes.

Source

pub fn wide(ch: char, attrs: SgrAttrs) -> (Self, Self)

Create a wide (2-column) character cell.

Returns (leading, continuation) pair. The leading cell holds the character; the continuation cell is a placeholder.

Source

pub fn content(&self) -> char

The character content of this cell.

Source

pub fn width(&self) -> u8

The display width in terminal columns.

Source

pub fn is_wide(&self) -> bool

Whether this cell is the leading half of a wide character.

Source

pub fn is_wide_continuation(&self) -> bool

Whether this cell is a continuation (trailing half) of a wide character.

Source

pub fn set_content(&mut self, ch: char, width: u8)

Set the character content and display width.

Source

pub fn erase(&mut self, bg: Color)

Reset this cell to a blank space with the given background attributes.

Used by erase operations (ED, EL, ECH) which fill with the current background color but reset all other attributes.

Source

pub fn clear(&mut self)

Reset this cell to a blank space with default attributes.

Source

pub fn push_combining(&mut self, mark: char) -> bool

Append a combining mark to this cell’s grapheme cluster.

Returns true if the mark was stored, false if the inline buffer is full (excess marks are silently dropped).

Source

pub fn combining_marks(&self) -> &[char]

The combining marks attached to this cell’s base character.

Source

pub fn has_combining(&self) -> bool

Whether this cell has any combining marks.

Source

pub fn display_width(ch: char) -> u8

Compute terminal display width for a single Unicode scalar.

Returns:

  • 0 for non-spacing marks/format controls (combining marks, ZWJ, VS16, etc.)
  • 1 for narrow characters
  • 2 for wide characters (CJK, emoji presentation)

Widths above 2 are clamped to 2 for terminal cell semantics.

Trait Implementations§

Source§

impl Clone for Cell

Source§

fn clone(&self) -> Cell

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Cell

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Cell

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Cell

Source§

fn eq(&self, other: &Cell) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Cell

Source§

impl Eq for Cell

Source§

impl StructuralPartialEq for Cell

Auto Trait Implementations§

§

impl Freeze for Cell

§

impl RefUnwindSafe for Cell

§

impl Send for Cell

§

impl Sync for Cell

§

impl Unpin for Cell

§

impl UnwindSafe for Cell

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.