win32console 0.1.5

Provides a wrapper to interact with the windows console from rust
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use std::convert::TryFrom;
use std::fmt::{Display, Error, Formatter, Debug};

/// Represents a color for the windows console.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub enum ConsoleColor {
    Black = 0,
    DarkBlue = 1,
    DarkGreen = 2,
    DarkCyan = 3,
    DarkRed = 4,
    DarkMagenta = 5,
    DarkYellow = 6,
    Gray = 7,
    DarkGray = 8,
    Blue = 9,
    Green = 10,
    Cyan = 11,
    Red = 12,
    Magenta = 13,
    Yellow = 14,
    White = 15,
}

impl ConsoleColor {
    /// Gets the `ConsoleTextAttribute` representation of this as foreground color.
    ///
    /// # Example
    /// ```
    /// use win32console::structs::console_color::ConsoleColor;
    /// use win32console::console::WinConsole;
    ///
    /// let color = ConsoleColor::Red.as_foreground_color();
    /// WinConsole::output().set_text_attribute(color);
    /// WinConsole::output().write_utf8("Hello World!".as_bytes());
    /// ```
    #[inline]
    pub fn as_foreground_color(&self) -> u16 {
        *self as u16
    }

    /// Gets the `ConsoleTextAttribute` representation of this as background color.
    ///
    /// # Example
    /// ```
    /// use win32console::structs::console_color::ConsoleColor;
    /// use win32console::console::WinConsole;
    ///
    /// let color = ConsoleColor::Red.as_background_color();
    /// WinConsole::output().set_text_attribute(color);
    /// WinConsole::output().write_utf8("Hello World!".as_bytes());
    /// ```
    #[inline]
    pub fn as_background_color(&self) -> u16 {
        (*self as u16) << 4
    }
}

/// Represents an error when parsing a color, and contains the invalid `ConsoleTextAttribute` value.
pub struct ParseColorError(u16);
impl Debug for ParseColorError{
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "Invalid color value: {}", self.0)
    }
}

impl TryFrom<u16> for ConsoleColor{
    type Error = ParseColorError;

    fn try_from(value: u16) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(ConsoleColor::Black),
            1 => Ok(ConsoleColor::DarkBlue),
            2 => Ok(ConsoleColor::DarkGreen),
            3 => Ok(ConsoleColor::DarkCyan),
            4 => Ok(ConsoleColor::DarkRed),
            5 => Ok(ConsoleColor::DarkMagenta),
            6 => Ok(ConsoleColor::DarkYellow),
            7 => Ok(ConsoleColor::Gray),
            8 => Ok(ConsoleColor::DarkGray),
            9 => Ok(ConsoleColor::Blue),
            10 => Ok(ConsoleColor::Green),
            11 => Ok(ConsoleColor::Cyan),
            12 => Ok(ConsoleColor::Red),
            13 => Ok(ConsoleColor::Magenta),
            14 => Ok(ConsoleColor::Yellow),
            15 => Ok(ConsoleColor::White),
            _ => Err(ParseColorError(value))
        }
    }
}

impl Into<u16> for ConsoleColor {
    #[inline]
    fn into(self) -> u16 {
        self.as_foreground_color()
    }
}

impl Display for ConsoleColor{
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
        match self {
            ConsoleColor::Black => { f.write_str("ConsoleColor::Black") },
            ConsoleColor::DarkBlue => { f.write_str("ConsoleColor::DarkBlue") },
            ConsoleColor::DarkGreen => { f.write_str("ConsoleColor::DarkGreen") },
            ConsoleColor::DarkCyan => { f.write_str("ConsoleColor::DarkCyan") },
            ConsoleColor::DarkRed => { f.write_str("ConsoleColor::DarkRed") },
            ConsoleColor::DarkMagenta => { f.write_str("ConsoleColor::DarkMagenta") },
            ConsoleColor::DarkYellow => { f.write_str("ConsoleColor::DarkYellow") },
            ConsoleColor::Gray => { f.write_str("ConsoleColor::Gray") },
            ConsoleColor::DarkGray => { f.write_str("ConsoleColor::DarkGray") },
            ConsoleColor::Blue => { f.write_str("ConsoleColor::Blue") },
            ConsoleColor::Green => { f.write_str("ConsoleColor::Green") },
            ConsoleColor::Cyan => { f.write_str("ConsoleColor::Cyan") },
            ConsoleColor::Red => { f.write_str("ConsoleColor::Red") },
            ConsoleColor::Magenta => { f.write_str("ConsoleColor::Magenta") },
            ConsoleColor::Yellow => { f.write_str("ConsoleColor::Yellow") },
            ConsoleColor::White => { f.write_str("ConsoleColor::White") },
        }
    }
}

#[cfg(test)]
mod tests{
    use super::ConsoleColor;
    use crate::console::ConsoleTextAttribute;
    use std::convert::TryFrom;

    #[test]
    fn as_foreground_test(){
        let color = ConsoleColor::DarkRed;
        assert_eq!(ConsoleTextAttribute::FOREGROUND_RED, color.as_foreground_color());
    }

    #[test]
    fn as_background_test(){
        let color = ConsoleColor::DarkRed;
        assert_eq!(ConsoleTextAttribute::BACKGROUND_RED, color.as_background_color());
    }

    #[test]
    fn try_from_test1(){
        let color = ConsoleColor::try_from(4).ok();
        assert!(color.is_some());
        assert_eq!(ConsoleColor::DarkRed, color.unwrap())
    }

    #[test]
    fn try_from_test2(){
        let color = ConsoleColor::try_from(12).ok();
        assert!(color.is_some());
        assert_eq!(ConsoleColor::Red, color.unwrap())
    }
}