handsome_logger 0.9.2

A fast, handsome and quite easy to use 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::io::{Error, Write};
use std::sync::Mutex;

use log::{set_boxed_logger, set_max_level, Level, LevelFilter, Log, Metadata, Record, SetLoggerError};
use termcolor::{BufferedStandardStream, ColorChoice};

use crate::common::get_env_log;
use crate::{Config, SharedLogger};

use super::logging::*;

pub struct OutputStreams {
    pub(crate) err: BufferedStandardStream,
    pub(crate) out: BufferedStandardStream,
}

#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash, Default)]
pub enum TerminalMode {
    Stdout,
    Stderr,
    #[default]
    Mixed,
}

pub struct TermLogger {
    level: LevelFilter,
    config: Config,
    streams: Mutex<OutputStreams>,
}

impl TermLogger {
    pub fn init(config: Config, mode: TerminalMode, color_choice: ColorChoice) -> Result<(), SetLoggerError> {
        let log_level = get_env_log().unwrap_or(config.level);
        set_max_level(log_level);
        let logger = Self::new(config, mode, color_choice);
        set_boxed_logger(logger)
    }

    #[must_use]
    pub fn new(mut config: Config, mode: TerminalMode, color_choice: ColorChoice) -> Box<Self> {
        let streams = match mode {
            TerminalMode::Stdout => OutputStreams {
                err: BufferedStandardStream::stdout(color_choice),
                out: BufferedStandardStream::stdout(color_choice),
            },
            TerminalMode::Stderr => OutputStreams {
                err: BufferedStandardStream::stderr(color_choice),
                out: BufferedStandardStream::stderr(color_choice),
            },
            TerminalMode::Mixed => OutputStreams {
                err: BufferedStandardStream::stderr(color_choice),
                out: BufferedStandardStream::stdout(color_choice),
            },
        };

        config.calculate_data();

        let log_level = get_env_log().unwrap_or(config.level);

        Box::new(Self {
            level: log_level,
            config,
            streams: Mutex::new(streams),
        })
    }

    #[must_use]
    pub fn new_from_config(config: Config) -> Box<Self> {
        Self::new(config, TerminalMode::Mixed, ColorChoice::Auto)
    }

    pub fn init_from_config(config: Config) -> Result<(), SetLoggerError> {
        let log_level = get_env_log().unwrap_or(config.level);
        set_max_level(log_level);
        let logger = Self::new_from_config(config);
        set_boxed_logger(logger)
    }

    fn try_log(&self, record: &Record) -> Result<(), Error> {
        if self.enabled(record.metadata()) {
            let mut streams = self.streams.lock().unwrap();

            if let Some(terminal_logger) = &self.config.terminal_formatter {
                if record.level() == Level::Error {
                    terminal_logger(record, &mut streams.err)
                } else {
                    terminal_logger(record, &mut streams.out)
                }
            } else if record.level() == Level::Error {
                try_log_term(&self.config, record, &mut streams.err)
            } else {
                try_log_term(&self.config, record, &mut streams.out)
            }
        } else {
            Ok(())
        }
    }
}

impl Log for TermLogger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata.level() <= self.level
    }

    fn log(&self, record: &Record) {
        if let Some(message_filtering) = &self.config.message_filtering {
            if !message_filtering(record) {
                return;
            }
        }

        let _ = self.try_log(record);
    }

    fn flush(&self) {
        let mut streams = self.streams.lock().unwrap();
        let _ = streams.out.flush();
        let _ = streams.err.flush();
    }
}

impl SharedLogger for TermLogger {
    fn level(&self) -> LevelFilter {
        self.level
    }

    fn config(&self) -> Option<&Config> {
        Some(&self.config)
    }

    fn as_log(self: Box<Self>) -> Box<dyn Log> {
        Box::new(*self)
    }
}