Struct meli::terminal::cells::Cell

pub struct Cell {
    ch: char,
    empty: bool,
    fg: Color,
    bg: Color,
    attrs: Attr,
    keep_fg: bool,
    keep_bg: bool,
    keep_attrs: bool,
}

A single point on a terminal display.

A Cell contains a character and style.

Fields

ch: char

empty: bool

Set a Cell as empty when a previous cell spans multiple columns and it would "overflow" to this cell.

fg: Color

bg: Color

attrs: Attr

keep_fg: bool

keep_bg: bool

keep_attrs: bool

Implementations

impl Cell

pub fn new(ch: char, fg: Color, bg: Color, attrs: Attr) -> Cell

Creates a new Cell with the given char, Colors and Attr.

Examples

let cell = Cell::new('x', Color::Default, Color::Green, Attr::DEFAULT);
assert_eq!(cell.ch(), 'x');
assert_eq!(cell.fg(), Color::Default);
assert_eq!(cell.bg(), Color::Green);
assert_eq!(cell.attrs(), Attr::DEFAULT);

pub fn with_char(ch: char) -> Cell

Creates a new Cell with the given char and default style.

Examples

let mut cell = Cell::with_char('x');
assert_eq!(cell.ch(), 'x');
assert_eq!(cell.fg(), Color::Default);
assert_eq!(cell.bg(), Color::Default);
assert_eq!(cell.attrs(), Attr::DEFAULT);

pub fn with_style(fg: Color, bg: Color, attr: Attr) -> Cell

Creates a new Cell with the given style and a blank char.

Examples

let mut cell = Cell::with_style(Color::Default, Color::Red, Attr::BOLD);
assert_eq!(cell.fg(), Color::Default);
assert_eq!(cell.bg(), Color::Red);
assert_eq!(cell.attrs(), Attr::BOLD);
assert_eq!(cell.ch(), ' ');

pub fn ch(&self) -> char

Returns the Cell's character.

Examples

let mut cell = Cell::with_char('x');
assert_eq!(cell.ch(), 'x');

pub fn set_ch(&mut self, newch: char) -> &mut Cell

Sets the Cell's character to the given char

Examples

let mut cell = Cell::with_char('x');
assert_eq!(cell.ch(), 'x');

cell.set_ch('y');
assert_eq!(cell.ch(), 'y');

pub fn fg(&self) -> Color

Returns the Cell's foreground Color.

Examples

let mut cell = Cell::with_style(Color::Blue, Color::Default, Attr::DEFAULT);
assert_eq!(cell.fg(), Color::Blue);

pub fn set_fg(&mut self, newfg: Color) -> &mut Cell

Sets the Cell's foreground Color to the given Color.

Examples

let mut cell = Cell::default();
assert_eq!(cell.fg(), Color::Default);

cell.set_fg(Color::White);
assert_eq!(cell.fg(), Color::White);

pub fn bg(&self) -> Color

Returns the Cell's background Color.

Examples

let mut cell = Cell::with_style(Color::Default, Color::Green, Attr::DEFAULT);
assert_eq!(cell.bg(), Color::Green);

pub fn set_bg(&mut self, newbg: Color) -> &mut Cell

Sets the Cell's background Color to the given Color.

Examples

let mut cell = Cell::default();
assert_eq!(cell.bg(), Color::Default);

cell.set_bg(Color::Black);
assert_eq!(cell.bg(), Color::Black);

pub fn attrs(&self) -> Attr

pub fn set_attrs(&mut self, newattrs: Attr) -> &mut Cell

pub fn empty(&self) -> bool

Set a Cell as empty when a previous cell spans multiple columns and it would "overflow" to this cell.

pub fn set_empty(&mut self, new_val: bool) -> &mut Cell

pub fn set_keep_fg(&mut self, new_val: bool) -> &mut Cell

Sets keep_fg field. If true, the foreground color will not be altered if attempted so until the character content of the cell is changed.

pub fn set_keep_bg(&mut self, new_val: bool) -> &mut Cell

Sets keep_bg field. If true, the background color will not be altered if attempted so until the character content of the cell is changed.

pub fn set_keep_attrs(&mut self, new_val: bool) -> &mut Cell

Sets keep_attrs field. If true, the text attributes will not be altered if attempted so until the character content of the cell is changed.

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Cell

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

Constructs a new Cell with a blank char and default Colors.

Examples

let mut cell = Cell::default();
assert_eq!(cell.ch(), ' ');
assert_eq!(cell.fg(), Color::Default);
assert_eq!(cell.bg(), Color::Default);

impl Eq for Cell

impl PartialEq<Cell> for Cell

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

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

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

This method tests for !=.

impl StructuralEq for Cell

impl StructuralPartialEq for Cell