doclog 0.3.0

A Rust log library based on Rust's compiler logs
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

use std::cmp::Ordering;

use yansi::Color;

/// The trace log level. Level = 10.
const TRACE: LogLevel = LogLevel::new(10, Color::Fixed(102), "trace", '•');

/// The debug log level. Level = 20.
const DEBUG: LogLevel = LogLevel::new(20, Color::Green, "debug", '•');

/// The info log level. Level = 30.
const INFO: LogLevel = LogLevel::new(30, Color::Blue, "info", '•');

/// The warn log level. Level = 40.
const WARN: LogLevel = LogLevel::new(40, Color::Yellow, "warn", '⚠');

/// The error log level. Level = 50.
const ERROR: LogLevel = LogLevel::new(50, Color::Red, "error", '×');

/// The different levels of logging.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub struct LogLevel {
    level: u8,
    color: Color,
    tag: &'static str,
    symbol: char,
}

impl LogLevel {
    // CONSTRUCTORS -----------------------------------------------------------

    /// Builds a new log level.
    pub const fn new(level: u8, color: Color, tag: &'static str, symbol: char) -> LogLevel {
        LogLevel {
            level,
            tag,
            color,
            symbol,
        }
    }

    // GETTERS ----------------------------------------------------------------

    /// Returns a number that defines an order between log levels.
    pub const fn level(&self) -> u8 {
        self.level
    }

    /// Returns the tag that represents the log level.
    pub const fn tag(&self) -> &'static str {
        self.tag
    }

    /// Returns the color that represents the log level.
    pub const fn color(&self) -> Color {
        self.color
    }

    /// Returns the symbol that represents the log level.
    pub const fn symbol(&self) -> char {
        self.symbol
    }

    // STATIC METHODS ---------------------------------------------------------

    /// Returns the TRACE log level.
    pub const fn trace() -> LogLevel {
        TRACE
    }

    /// Returns the DEBUG log level.
    pub const fn debug() -> LogLevel {
        DEBUG
    }

    /// Returns the INFO log level.
    pub const fn info() -> LogLevel {
        INFO
    }

    /// Returns the WARN log level.
    pub const fn warn() -> LogLevel {
        WARN
    }

    /// Returns the ERROR log level.
    pub const fn error() -> LogLevel {
        ERROR
    }
}

impl PartialOrd for LogLevel {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for LogLevel {
    fn cmp(&self, other: &Self) -> Ordering {
        self.level.cmp(&other.level)
    }
}

// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------

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

    #[test]
    fn test_order() {
        assert!(TRACE < DEBUG, "TRACE is not less than DEBUG");
        assert!(DEBUG < INFO, "DEBUG is not less than INFO");
        assert!(INFO < WARN, "INFO is not less than WARN");
        assert!(WARN < ERROR, "WARN is not less than ERROR");
    }
}