colorama 1.0.0

A simple way to colorize the output of your cli application.
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233

//! # colorama
//!
//! A simple way to colorize the output of your cli application.
//!
//! This crate contains a single trait `Colored` that is implemented for the `String` type.
//! Calling `.color("red")`, `.background("green")` or `.style("bold")`
//! will wrap your string with the corresponding ANSI escape sequence.
//!
//! Different styles can be concatenated together:
//! ```rust
//! use colorama::Colored;
//!
//! let mut s = String::from("colorama");
//!
//! s.color("red").background("green").style("bold");
//!
//! println!("{}", s);
//! assert_eq!(s, "\x1b[1m\x1b[42m\x1b[31mcolorama\x1b[0m\x1b[0m\x1b[0m");
//! ```
//! Unknown color / style names are silently ignored.
//!
//! Note: This package does not check if the program is running inside a terminal or
//! if it is called via pipes. If you want this functionality, check out
//! [termcolor](https://crates.io/crates/termcolor), [colored](https://crates.io/crates/colored)
//! and / or [atty](https://crates.io/crates/atty).
//!

fn map_color(color: &str) -> Option<&str> {
    match color {
        "normal" => Some("\x1b[0m"),
        "black" => Some("\x1b[30m"),
        "red" => Some("\x1b[31m"),
        "green" => Some("\x1b[32m"),
        "yellow" => Some("\x1b[33m"),
        "blue" => Some("\x1b[34m"),
        "magenta" => Some("\x1b[35m"),
        "cyan" => Some("\x1b[36m"),
        "white" => Some("\x1b[37m"),
        "bright black" => Some("\x1b[90m"),
        "bright red" => Some("\x1b[91m"),
        "bright green" => Some("\x1b[92m"),
        "bright yellow" => Some("\x1b[93m"),
        "bright blue" => Some("\x1b[94m"),
        "bright magenta" => Some("\x1b[95m"),
        "bright cyan" => Some("\x1b[96m"),
        "bright white" => Some("\x1b[97m"),
        _ => None,
    }
}

fn map_background(background: &str) -> Option<&str> {
    match background {
        "normal" => Some("\x1b[0m"),
        "black" => Some("\x1b[40m"),
        "red" => Some("\x1b[41m"),
        "green" => Some("\x1b[42m"),
        "yellow" => Some("\x1b[43m"),
        "blue" => Some("\x1b[44m"),
        "magenta" => Some("\x1b[45m"),
        "cyan" => Some("\x1b[46m"),
        "white" => Some("\x1b[47m"),
        "bright black" => Some("\x1b[100m"),
        "bright red" => Some("\x1b[101m"),
        "bright green" => Some("\x1b[102m"),
        "bright yellow" => Some("\x1b[103m"),
        "bright blue" => Some("\x1b[104m"),
        "bright magenta" => Some("\x1b[105m"),
        "bright cyan" => Some("\x1b[106m"),
        "bright white" => Some("\x1b[107m"),
        _ => None,
    }
}

fn map_style(style: &str) -> Option<&str> {
    match style {
        "normal" => Some("\x1b[0m"),
        "bold" => Some("\x1b[1m"),
        "faint" => Some("\x1b[2m"),
        "italic" => Some("\x1b[3m"),
        "underline" => Some("\x1b[4m"),
        _ => None,
    }
}

pub trait Colored {
    /// Display String in a given color.
    /// Possible values are:
    ///
    /// normal, black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red, bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white
    ///
    /// # Example
    /// ```
    /// use colorama::Colored;
    ///
    /// let mut s = String::from("colorama");
    /// s.color("red");
    ///
    /// assert_eq!(s, "\x1b[31mcolorama\x1b[0m");
    /// ```
    fn color(&mut self, color: &str) -> &mut Self;

    /// Display String with a given background color.
    /// Possible values are:
    ///
    /// normal, black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red, bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white
    ///
    /// # Example
    /// ```
    /// use colorama::Colored;
    ///
    /// let mut s = String::from("colorama");
    /// s.background("red");
    ///
    /// assert_eq!(s, "\x1b[41mcolorama\x1b[0m");
    /// ```
    fn background(&mut self, background: &str) -> &mut Self;

    /// Display String in a given style.
    /// Possible values are:
    ///
    /// normal, bold, faint, italic, underline
    ///
    /// # Example
    /// ```
    /// use colorama::Colored;
    ///
    /// let mut s = String::from("colorama");
    /// s.style("underline");
    ///
    /// assert_eq!(s, "\x1b[4mcolorama\x1b[0m");
    /// ```
    fn style(&mut self, style: &str) -> &mut Self;
}

impl Colored for String {
    /// Display String in a given color.
    /// Possible values are:
    ///
    /// normal, black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red, bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white
    ///
    /// # Example
    /// ```
    /// use colorama::Colored;
    ///
    /// let mut s = String::from("colorama");
    /// s.color("red");
    ///
    /// assert_eq!(s, "\x1b[31mcolorama\x1b[0m");
    /// ```
    fn color(&mut self, color: &str) -> &mut Self {
        map_color(color).map(|c| {
            self.insert_str(0, c);
            self.push_str("\x1b[0m");
        });

        self
    }

    /// Display String with a given background color.
    /// Possible values are:
    ///
    /// normal, black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red, bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white
    ///
    /// # Example
    /// ```
    /// use colorama::Colored;
    ///
    /// let mut s = String::from("colorama");
    /// s.background("red");
    ///
    /// assert_eq!(s, "\x1b[41mcolorama\x1b[0m");
    /// ```
    fn background(&mut self, background: &str) -> &mut Self {
        map_background(background).map(|b| {
            self.insert_str(0, b);
            self.push_str("\x1b[0m");
        });

        self
    }

    /// Display String in a given style.
    /// Possible values are:
    ///
    /// normal, bold, faint, italic, underline
    ///
    /// # Example
    /// ```
    /// use colorama::Colored;
    ///
    /// let mut s = String::from("colorama");
    /// s.style("underline");
    ///
    /// assert_eq!(s, "\x1b[4mcolorama\x1b[0m");
    /// ```
    fn style(&mut self, style: &str) -> &mut Self {
        map_style(style).map(|s| {
            self.insert_str(0, s);
            self.push_str("\x1b[0m");
        });

        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn no_match() {
        let mut s = String::from("colorama");
        s.color("unknown");

        assert_eq!(s, "colorama");
    }

    #[test]
    fn color_and_style() {
        let mut s = String::from("colorama");
        s.color("red").style("bold");

        assert_eq!(s, "\x1b[1m\x1b[31mcolorama\x1b[0m\x1b[0m");
    }

    #[test]
    fn color_background_and_style() {
        let mut s = String::from("colorama");
        s.color("red").background("green").style("bold");

        assert_eq!(s, "\x1b[1m\x1b[42m\x1b[31mcolorama\x1b[0m\x1b[0m\x1b[0m");
    }
}