clerr 0.11.0

This library aids in command-line error reporting.
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

use colored::{Color, Colorize};
use std::fmt::{Display, Formatter};

/// The severity of a command-line report.
#[must_use]
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub enum Severity {
    /// An error.
    Error,
    /// A warning.
    Warning,
    /// Information.
    Info,
}

impl Severity {
    //! Display

    /// Gets the label string.
    #[must_use]
    pub fn label(self) -> &'static str {
        match self {
            Self::Error => "error",
            Self::Warning => "warning",
            Self::Info => "info",
        }
    }

    /// Gets the associated color.
    #[must_use]
    pub fn color(self) -> Color {
        match self {
            Self::Error => Color::BrightRed,
            Self::Warning => Color::BrightYellow,
            Self::Info => Color::BrightBlue,
        }
    }
}

impl Display for Severity {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.label().color(self.color()))
    }
}

#[cfg(test)]
mod tests {
    use crate::Severity;
    use colored::{Color, Colorize};

    #[test]
    fn display() {
        let test_cases: &[(Severity, &str, Color)] = &[
            (Severity::Error, "error", Color::BrightRed),
            (Severity::Warning, "warning", Color::BrightYellow),
            (Severity::Info, "info", Color::BrightBlue),
        ];
        for (severity, expected_label, expected_color) in test_cases {
            let result: String = severity.to_string();
            let expected: String = expected_label.color(*expected_color).to_string();
            assert_eq!(result, expected);
        }
    }
}