Struct Cell 

pub struct Cell { /* private fields */ }

A Cell corresponds to a single grapheme cluster on some Plane,

A Cell is bounded to n Plane, but the cell doesn’t store anything about the plane.

At any NcCell, we can have a theoretically arbitrarily long UTF-8 string, a foreground color, a background color, and a Style attribute set.

Implementations

impl Cell

constructors

pub fn new() -> Cell

Creates an empty cell.

pub fn from_str(plane: &mut Plane, string: &str) -> Result<Cell>

Returns a Cell from a string.

It only stores the first extended grapheme cluster from the string.

impl Cell

egc

methods

pub const fn uses_egcpool(&self) -> bool

Returns true if the egc is stored in the associated plane’s egc pool, or false if the egc is stored entirely within the cell,

Egcs of up to 4 bytes are stored in the cell.

pub fn try_egc(&self) -> Option<String>

Returns the extended grapheme cluster only if it’s stored in the cell.

Returns none if the egc is stored in the associated plane.

pub fn egc(&self, plane: &mut Plane) -> &str

Returns a reference to the egc.

impl Cell

channel methods

pub fn channels(&self) -> Channels

Gets the channels.

pub fn fg(&self) -> Channel

Gets the foreground channel.

pub fn bg(&self) -> Channel

Gets the background channel.

pub fn set_channels(&mut self, channels: impl Into<Channels>) -> Channels

Sets the channels, returning the previous value.

pub fn set_fg(&mut self, channel: impl Into<Channel>) -> Channel

Sets the foreground channel, returning the previous value.

pub fn set_bg(&mut self, channel: impl Into<Channel>) -> Channel

Sets the background channel, returning the previous value.

pub fn cset_channels(self, channels: impl Into<Channels>) -> Self

Chain-sets the channels.

pub fn cset_fg(self, channel: impl Into<Channel>) -> Self

Chain-sets the foreground channel.

pub fn cset_bg(self, channel: impl Into<Channel>) -> Self

Chain-sets the foreground channel.

impl Cell

alpha methods

pub fn fg_alpha(&self) -> Alpha

Gets the foreground alpha.

pub fn bg_alpha(&self) -> Alpha

Gets the background alpha.

pub fn set_fg_alpha(&mut self, foreground: Alpha) -> Alpha

Sets the foreground alpha, returning the previous value.

pub fn set_bg_alpha(&mut self, background: Alpha) -> Alpha

Gets the background alpha, returning the previous value.

impl Cell

style methods

pub fn styles(&self) -> Style

Gets the styles.

pub fn set_styles(&mut self, styles: impl Into<Style>) -> Style

Sets the styles, returning the previous value.

pub fn add_styles(&mut self, styles: impl Into<Style>) -> Style

Adds the specified styles, returning the previous value.

pub fn del_styles(&mut self, styles: impl Into<Style>) -> Style

Deletes the specified styles, returning the previous value.

pub fn cset_style(self, styles: impl Into<Style>) -> Self

Chain-sets the styles.

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 Default for Cell

fn default() -> Cell

Returns the “default value” for a type.

impl Display for Cell

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

Formats the value using the given formatter.

impl<'c> From<&'c Cell> for &'c NcCell

fn from(c: &'c Cell) -> &'c NcCell

Converts to this type from the input type.

impl From<Cell> for NcCell

fn from(c: Cell) -> NcCell

Converts to this type from the input type.

impl From<nccell> for Cell

fn from(nc: NcCell) -> Cell

Converts to this type from the input type.

impl PartialEq for Cell

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

impl Eq for Cell

impl StructuralPartialEq for Cell