Struct Character 

pub struct Character { /* private fields */ }

A colored character, has the same memory layout as u32.

Examples

use color_char::Character;
let c = Character::default().with_char('Z').with_color(26);

Implementations

impl Character

pub fn new(char: char, color: u32) -> Self

Create a new colored character with the given character and color.

Examples

use color_char::Character;

pub fn get_char(&self) -> char

Get the character for last 21 bits

Examples

use color_char::Character;
let c = Character::from(0b000011010_000000000000001011010);
assert_eq!(c.get_char(), 'Z');
assert_eq!(c.get_color(), 26);

pub fn set_char(&mut self, new: char)

Set the character on last 21 bits

Examples

use color_char::Character;
let mut c = Character::default();
c.set_char('Z');
assert_eq!(c, 'Z');

pub fn with_char(self, new: char) -> Self

Build a new character with given char

Examples

use color_char::Character;
let c = Character::default().with_char('Z');
assert_eq!(c, 'Z');

pub fn get_color(&self) -> u32

Get the color id from first 11 bits

Examples

use color_char::Character;
let c = Character::from(0b000011010_000000000000001011010);
assert_eq!(c.get_color(), 26);

pub fn set_color(&mut self, new: u32)

Set the color id on first 11 bits

Examples

use color_char::Character;
let mut c = Character::default();
c.set_color(26);
assert_eq!(c.get_color(), 26);

pub fn with_color(self, new: u32) -> Self

Build a new character with given color

Examples

use color_char::Character;
let c = Character::default().with_color(26);
assert_eq!(c.get_color(), 26);

Trait Implementations

impl Binary for Character

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

Formats the value using the given formatter.

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 Debug for Character

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

Formats the value using the given formatter.

impl Default for Character

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Character

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Character

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

Formats the value using the given formatter.

impl From<char> for Character

fn from(value: char) -> Self

Converts to this type from the input type.

impl From<u32> for Character

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for Character

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Character

fn cmp(&self, other: &Character) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<char> for Character

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

fn partial_cmp(&self, other: &Character) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Character

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 Character

impl Eq for Character

impl StructuralPartialEq for Character