Struct Character 

pub struct Character {
    pub code: char,
    pub foreground: Color,
    pub background: Color,
    pub flags: CharFlags,
}

Represents a character with its attributes, including foreground and background colors, and flags. The Character struct is used to define a character that can be displayed on the screen.

Fields

code: char

foreground: Color

background: Color

flags: CharFlags

Implementations

impl Character

pub fn new<T>(code: T, fore: Color, back: Color, flags: CharFlags) -> Self

where char: From<T>,

Creates a new character with the specified code, foreground color, background color, and flags. The code could be of type char or a SpecialChar.

Example

use appcui::prelude::*;
let ch = Character::new('A', Color::Red, Color::Black, CharFlags::None);
let special_ch = Character::new(SpecialChar::BoxTopLeftCornerDoubleLine, 
                                Color::Green, 
                                Color::Black, 
                                CharFlags::None);

pub fn with_char<T>(code: T) -> Self

where char: From<T>,

Creates a new character from a specified code (a char or a SpecialChar). The foreground and background colors are set to transparent and th e flags are set to None.

Example

use appcui::prelude::*;
let ch = Character::with_char('A');
let special_ch = Character::with_char(SpecialChar::BoxTopLeftCornerDoubleLine);

pub fn with_color(fore: Color, back: Color) -> Self

Creates a new character with the specified foreground and background colors. The code is set to the null character (‘\0’) - meaning that it will not overwrite the existing character when displayed on the surface. The flags are set to None.

Example

use appcui::prelude::*;
 
let ch = Character::with_color(Color::Red, Color::Black);

pub fn with_attributes<T>(code: T, attr: CharAttribute) -> Self

where char: From<T>,

Creates a new character with the specified code (a char or a SpecialChar) and attributes. The foreground and background colors are set to the values specified in the CharAttribute struct.

Example

use appcui::prelude::*;
 
let attr = CharAttribute::new(Color::Red, Color::Black, CharFlags::None);
let ch = Character::with_attributes('A', attr);
let special_ch = Character::with_attributes(SpecialChar::BoxTopLeftCornerDoubleLine, attr);

pub fn set(&mut self, ch: Character)

Sets an character based on the provided Character instance. The code, foreground color, and background color are updated only if they are not set to the default values Foe example, the character code is only set if the ch argument is not 0. Similarly, if the background or foreground colors are not set to Color::Transparent, they will be updated. The flags are always updated.

Trait Implementations

impl Clone for Character

fn clone(&self) -> Character

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Character

impl Debug for Character

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

Formats the value using the given formatter.

impl Default for Character

fn default() -> Self

Creates a new character with default values. The code is set to a space character (’ ’), the foreground color is set to Color::White, the background color is set to Color::Black, and the flags are set to CharFlags::None.

impl Eq for Character

impl PartialEq for Character

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