carrot_utils 0.1.7

Utils library
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

use crate::path::format_time_macro;

use log::{info, LevelFilter, SetLoggerError};
use simplelog::{ColorChoice, CombinedLogger, Config, TermLogger, TerminalMode};
use std::fs;
use std::path::PathBuf;

/// Get log level from &str
pub fn get_log_level(log_level: &str) -> LevelFilter {
    match &log_level[..] {
        "Error" => LevelFilter::Error,
        "Warn" => LevelFilter::Warn,
        "Info" => LevelFilter::Info,
        "Debug" => LevelFilter::Debug,
        "Trace" => LevelFilter::Trace,
        _ => LevelFilter::Info,
    }
}

/// Logger class
pub struct Logger {
    /// The root result of directory
    pub log_directory_path: PathBuf,
    pub log_file_path: PathBuf,
}

impl Logger {
    /// Init for Logger
    ///
    /// # Arguments
    /// - log_directory_path: The log directory path
    /// - log_file_name: The log file name
    /// - log_file_level: The log level for file logger
    /// - log_terminal_level: The log level for terminal logger
    /// - log_file_enable_level: The enable level for terminal logger
    pub fn new(
        log_directory_path: impl Into<String>,
        log_file_name: impl Into<String>,
        log_file_level: LevelFilter,
        log_terminal_level: LevelFilter,
        log_file_enable_level: LevelFilter,
    ) -> Logger {
        let formatted_log_directory_path: PathBuf = format_time_macro(log_directory_path.into());
        let formatted_log_file_path: PathBuf =
            formatted_log_directory_path.join(format_time_macro(log_file_name.into()));

        if log_file_level >= log_file_enable_level {
            let _ = Self::init_logger_with_log_files(
                &formatted_log_directory_path,
                &formatted_log_file_path,
                log_file_level,
                log_terminal_level,
            );
        } else {
            let _ = Self::init_logger_without_log_files(log_terminal_level);
        }

        Logger {
            log_directory_path: formatted_log_directory_path,
            log_file_path: formatted_log_file_path,
        }
    }

    fn init_logger_with_log_files(
        log_directory_path: &PathBuf,
        log_file_path: &PathBuf,
        log_file_level: LevelFilter,
        log_terminal_level: LevelFilter,
    ) -> Result<(), SetLoggerError> {
        let _ = fs::create_dir_all(log_directory_path);
        info!("Make log file to {:?}", log_directory_path);

        // logger init
        CombinedLogger::init(vec![
            TermLogger::new(
                log_terminal_level,
                Config::default(),
                TerminalMode::Mixed,
                ColorChoice::Auto,
            ),
            simplelog::WriteLogger::new(
                log_file_level,
                Config::default(),
                fs::File::create(log_file_path).unwrap(),
            ),
        ])
        //.unwrap();
    }

    fn init_logger_without_log_files(
        log_terminal_level: LevelFilter,
    ) -> Result<(), SetLoggerError> {
        // logger init
        TermLogger::init(
            log_terminal_level,
            Config::default(),
            TerminalMode::Mixed,
            ColorChoice::Auto,
        )
    }
}

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

    #[test]
    fn test_logger() {
        let _ = Logger::new(
            "./data/{TIME_SEC}",
            "log_{TIME_SEC}.txt",
            LevelFilter::Debug,
            LevelFilter::Debug,
            LevelFilter::Debug,
        );
        info!("[info] Logger with log file. this message can be printed.");
        debug!("[debug] Logger with log file. this message can be printed.");

        let _ = Logger::new(
            "./data/{TIME_SEC}",
            "log_{TIME_SEC}.txt",
            LevelFilter::Info,
            LevelFilter::Info,
            LevelFilter::Debug,
        );
        info!("[info] Logger without log file. this message can be printed.");
        debug!("[debug] Logger without log file. this message cannot be printed.");
    }
}