cliclr 0.1.2

A very simple wrapper for termcolor.
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

use termcolor::{Color, ColorSpec, StandardStream, WriteColor};
use crate::console_line::ConsoleLine;
use std::io::Write;

/// Prints colored text to the standard output.
/// 
/// # Parameters
/// - `stdout`: A mutable reference to a `StandardStream` to handle colored output.
/// - `line`: A reference to a `ConsoleLine`.
pub fn print_colored_text(line: &ConsoleLine, stdout: &mut StandardStream){
    stdout.set_color(ColorSpec::new().set_fg(Some(line.color))).unwrap();
    writeln!(stdout, "{}", &line.text).unwrap();
    stdout.reset().unwrap();
}

/// Prints colored text that is bold to the standard output.
/// 
/// # Parameters
/// - `stdout`: A mutable reference to a `StandardStream` to handle colored output.
/// - `line`: A reference to a `ConsoleLine`.
pub fn print_bold_text(line: &ConsoleLine, stdout: &mut StandardStream){
    stdout.set_color(ColorSpec::new().set_fg(Some(line.color)).set_bold(true)).unwrap();
    writeln!(stdout, "{}", &line.text).unwrap();
    stdout.reset().unwrap();
}

/// Prints colored text that has a specified background color to the standard output.
/// 
/// # Parameters
/// - `line`: A reference to a `ConsoleLine`.
/// - `stdout`: A mutable reference to a `StandardStream` to handle colored output.
/// - `background_color`: A color from termcolor to set the background color of the output.
pub fn print_background_color_text(line: &ConsoleLine, stdout: &mut StandardStream, background_color: Color){
    stdout.set_color(ColorSpec::new().set_fg(Some(line.color)).set_bg(Some(background_color))).unwrap();
    writeln!(stdout, "{}", &line.text).unwrap();
    stdout.reset().unwrap();
}

#[cfg(test)]
mod tests {
    use termcolor::ColorChoice;
    use super::*;
    #[test]
    pub fn test_print_background_color_text(){
        let mut stdout = StandardStream::stdout(ColorChoice::Always);
        let console_line = ConsoleLine {
            text: String::from("A first test."),
            color: Color::Cyan,
        };
        print_background_color_text(&console_line, &mut stdout, Color::Magenta);
    }

    #[test]
    pub fn test_print_bold_text(){
        let mut stdout = StandardStream::stdout(ColorChoice::Always);
        let console_line = ConsoleLine {
            text: String::from("A second test."),
            color: Color::Cyan,
        };
        print_bold_text(&console_line, &mut stdout);
    }

    #[test]
    pub fn test_print_colored_text(){
        let mut stdout = StandardStream::stdout(ColorChoice::Always);
        let console_line = ConsoleLine {
            text: String::from("A third test."),
            color: Color::Yellow,
        };
        print_colored_text(&console_line, &mut stdout);
    }
}