color-char 0.2.0

Character with color information
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

mod arith;
mod convert;
mod display;

#[cfg(feature = "serde")]
mod der;
#[cfg(feature = "serde")]
mod ser;
/// 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);
/// ```
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Character {
    repr: u32,
}

impl Character {
    /// Create a new colored character with the given character and color.
    ///
    /// # Examples
    ///
    /// ```
    /// use color_char::Character;
    /// ```
    pub fn new(char: char, color: u32) -> Self {
        Self { repr: color << 21 | char as u32 }
    }
    /// 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);
    /// ```
    #[inline]
    pub fn get_char(&self) -> char {
        unsafe { char::from_u32_unchecked(self.erase_color()) }
    }
    /// 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');
    /// ```
    #[inline]
    pub fn set_char(&mut self, new: char) {
        self.repr = self.erase_char() | new as u32
    }
    /// Build a new character with given char
    ///
    /// # Examples
    ///
    /// ```
    /// use color_char::Character;
    /// let c = Character::default().with_char('Z');
    /// assert_eq!(c, 'Z');
    /// ```
    #[inline]
    pub fn with_char(self, new: char) -> Self {
        Self { repr: self.erase_char() | new as 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);
    /// ```
    #[inline]
    pub fn get_color(&self) -> u32 {
        self.repr >> 21
    }
    /// 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);
    /// ```
    #[inline]
    pub fn set_color(&mut self, new: u32) {
        debug_assert!(new <= 0x07FF);
        self.repr = self.erase_color() | new << 21
    }
    /// 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);
    /// ```
    #[inline]
    pub fn with_color(self, new: u32) -> Self {
        debug_assert!(new <= 0x07FF);
        Self { repr: self.erase_color() | new << 21 }
    }
    #[inline]
    fn erase_color(&self) -> u32 {
        self.repr & 0x001FFFFF
    }
    #[inline]
    fn erase_char(&self) -> u32 {
        self.repr & 0xFFE00000
    }
}