Struct DrawCell 

#[non_exhaustive]
pub struct DrawCell<'a> {
    pub layer: u8,
    pub pos: Pos,
    pub tile: &'a Tile,
    pub grapheme: Option<&'a str>,
    pub tint: Tint,
}

One cell handed to a backend at draw time: the tile, plus the state that does not fit in one.

Tile is deliberately compact (20 bytes, no padding to spare), so a cell’s rarer members live in a sparse side table on Grid instead. A backend cannot reach that table, so they are delivered here.

This is a struct rather than a tuple because it has grown twice and will grow again. Each addition would otherwise break every backend’s draw signature and leave the meaning of a fourth or fifth unnamed element to the reader.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

layer: u8

Which layer this cell belongs to. Always 0 for cells arriving through Output::draw.

pos: Pos

Where the cell sits in the grid.

tile: &'a Tile

The tile itself.

grapheme: Option<&'a str>

The tile’s full grapheme cluster, or None to render Tile::glyph alone.

Some only for multi-codepoint clusters (combining marks, ZWJ sequences), and only ever Some when the egc feature is enabled: without it Grid never populates the side table, so a backend that does not support egc can ignore this entirely and render from Tile::glyph.

tint: Tint

How a pixel backend recolours this cell’s sprite.

Tint::None for the overwhelming majority of cells. Cell backends have no sprite to recolour and ignore it; see Tint.

Implementations

impl<'a> DrawCell<'a>

pub const fn new(pos: Pos, tile: &'a Tile) -> Self

A cell on layer 0 with no grapheme text and no tint: the shape almost every test and cell backend wants.

pub const fn on_layer(layer: u8, pos: Pos, tile: &'a Tile) -> Self

new on an explicit layer.

pub const fn with_grapheme(self, grapheme: Option<&'a str>) -> Self

This cell with grapheme as its full cluster text.

pub const fn with_tint(self, tint: Tint) -> Self

This cell with tint applied to its sprite.

Trait Implementations

impl<'a> Clone for DrawCell<'a>

fn clone(&self) -> DrawCell<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DrawCell<'a>

impl<'a> Debug for DrawCell<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for DrawCell<'a>

impl<'a> PartialEq for DrawCell<'a>

fn eq(&self, other: &DrawCell<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for DrawCell<'a>