Enum text_terminal::Character

pub enum Character {
    Single(char),
    Multi(String),
}

The character stored in each Unit of the terminal screen.

In the typical case, a character (e.g., an ASCII letter or a single UTF-8 character) fits into Rust’s primitive char type, so we use that by default.

In the rare case of a character that consist of multiple UTF-8 sequences, e.g., complex emoji, we store the entire character here as a dynamically-allocated String. This saves space in the typical case of a character being 4 bytes or less (char-sized).

Variants

Single(char)

Multi(String)

Implementations

impl Character

pub fn displayable_width(&self) -> u16

Returns the number of columns required to display this Character within a Unit, either a single char or a String.

A return value of 0 indicates this Unit requires special handling to determine its displayable width. This includes characters like new lines, carriage returns, tabs, etc.

Trait Implementations

impl Clone for Character

fn clone(&self) -> Character

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Character

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

Formats the value using the given formatter.

impl Default for Character

fn default() -> Self

Returns the “default value” for a type.

impl Display for Character

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

Formats the value using the given formatter.

impl PartialEq<Character> for Character

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Character

impl StructuralEq for Character

impl StructuralPartialEq for Character