Struct Grapheme 

pub struct Grapheme(/* private fields */);

One grapheme cluster: the smallest run of text a cell boundary may fall on.

PrintableText is one row and PrintableLines spans rows, but neither says how far a single cell reaches. A cluster does, and that is the unit the layout pass turns into a token: a StyledGrapheme holds one of these and the cells it occupies, so a renderer that cannot split a cluster is a renderer that cannot disagree about a width.

The distinction is not decorative. A row of tokens whose widths sum to the rectangle’s width still renders wrong if one token holds three clusters, because a backend writes a token into the single cell its width starts at.

Implementations

impl Grapheme

pub fn new(text: &str) -> &Self

Adopts one grapheme cluster.

Panics

In debug builds, panics when text is not exactly one printable grapheme cluster — empty text, several clusters, or a control character. Release builds do not check.

pub fn as_str(&self) -> &str

pub fn width(&self) -> usize

Returns the terminal cells this cluster occupies.

Defined by the crate’s shared width implementation, exactly as PrintableText::width is.

Trait Implementations

impl Debug for Grapheme

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

Formats the value using the given formatter.

impl PartialEq for Grapheme

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

impl StructuralPartialEq for Grapheme