aul 1.4.1

Another useless Logger
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

//! Module for different logging [Level]s
use std::fmt::{Display, Formatter};
use std::str::FromStr;

use crate::errors::ParseLogLevelError;

static NAMES: [&str; 5] = ["TRACE", "DEBUG", "INFO", "WARN", "ERROR"];

/// ### Used for specifying the Logging Level
///
/// Example:
/// ```
/// use aul::log;
/// use aul::level::Level;
///
/// log!(Level::INFO,"Hello")
/// // [INFO]: Hello
/// ```
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash,Default)]
pub enum Level {
    /// ### Designated for low priority, verbose information
    ///
    /// For Example: Tracing method calls
    TRACE,
    /// ### Designated for lower priority information
    ///
    /// For Example: Value of a specific variable
    DEBUG,
    /// ### Designated for useful information
    ///
    /// For Example: User connected with your server
    #[default]
    INFO,
    /// ### Designated for "hazardous" information
    ///
    /// For Example: Server didn't find setup file and use defaults
    WARN,
    /// ### Designated for very serious errors
    ///
    /// For Example: Subprocess exited with abnormal exit code
    ERROR,
}

impl Display for Level {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.pad(self.get_name())
    }
}

impl FromStr for Level {
    type Err = ParseLogLevelError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        NAMES
            .iter()
            .position(|&name| name.eq_ignore_ascii_case(s))
            .map(Level::try_from)
            .unwrap()
    }
}

impl TryFrom<usize> for Level {
    type Error = ParseLogLevelError;

    fn try_from(value: usize) -> Result<Self, Self::Error> {
        match value {
            0 => Some(Level::TRACE),
            1 => Some(Level::DEBUG),
            2 => Some(Level::INFO),
            3 => Some(Level::WARN),
            4 => Some(Level::ERROR),
            _ => None,
        }.ok_or(ParseLogLevelError::new())
    }
}


impl Level {
    fn get_name(&self) -> &'static str {
        NAMES[*self as usize]
    }
}

#[cfg(test)]
mod tests {
    use crate::level::Level;

    #[test]
    fn test_get_name() {
        assert_eq!(Level::INFO.get_name(), "INFO")
    }

    #[test]
    fn test_to_string() {
        assert_eq!(Level::DEBUG.to_string(), "DEBUG")
    }

    #[test]
    fn test_to_string_doesnt_equal_something_else() {
        assert_ne!(Level::WARN.to_string(), "DEBUG")
    }

    #[test]
    fn test_get_name_doesnt_equal_something_else() {
        assert_ne!(Level::DEBUG.to_string(), "INFO")
    }
}