Struct Cell 

#[non_exhaustive]
pub struct Cell {
    pub character: char,
    pub coordinates: (u32, u32),
    pub bg: Option<Colour>,
    pub fg: Option<Colour>,
}

A cell represents a single character in the terminal.

It can be sent from Tattoy to communicate the contents of the user’s terminal. And it can also be sent from a plugin to communicate the contents to be composited in a Tattoy layer.

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.

character: char

The cell’s character.

coordinates: (u32, u32)

The coordinates of the cell. [0, 0] is in the top-left.

bg: Option<Colour>

An optional colour for the cell’s background. If None (or null in the case of JSON) is used then the terminal’s default background colour will be used.

fg: Option<Colour>

An optional colour for the cell’s foreground. If None (or null in the case of JSON) is used then the terminal’s default foreground colour will be used.

Implementations

impl Cell

pub fn builder() -> CellBuilder

Create an instance of Cell using the builder syntax

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a duplicate 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<'de> Deserialize<'de> for Cell

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Cell

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Cell