simplelog/loggers/
simplelog.rs

1// Copyright 2016 Victor Brekenfeld
2//
3// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
4// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
5// http://opensource.org/licenses/MIT>, at your option. This file may not be
6// copied, modified, or distributed except according to those terms.
7
8//! Module providing the SimpleLogger Implementation
9
10use super::logging::try_log;
11use crate::{Config, SharedLogger};
12use log::{
13    set_boxed_logger, set_max_level, Level, LevelFilter, Log, Metadata, Record, SetLoggerError,
14};
15use std::io::{stderr, stdout};
16use std::sync::Mutex;
17
18/// The SimpleLogger struct. Provides a very basic Logger implementation
19pub struct SimpleLogger {
20    level: LevelFilter,
21    config: Config,
22    output_lock: Mutex<()>,
23}
24
25impl SimpleLogger {
26    /// init function. Globally initializes the SimpleLogger as the one and only used log facility.
27    ///
28    /// Takes the desired `Level` and `Config` as arguments. They cannot be changed later on.
29    /// Fails if another Logger was already initialized.
30    ///
31    /// # Examples
32    /// ```
33    /// # extern crate simplelog;
34    /// # use simplelog::*;
35    /// # fn main() {
36    /// let _ = SimpleLogger::init(LevelFilter::Info, Config::default());
37    /// # }
38    /// ```
39    pub fn init(log_level: LevelFilter, config: Config) -> Result<(), SetLoggerError> {
40        set_max_level(log_level);
41        set_boxed_logger(SimpleLogger::new(log_level, config))
42    }
43
44    /// allows to create a new logger, that can be independently used, no matter what is globally set.
45    ///
46    /// no macros are provided for this case and you probably
47    /// dont want to use this function, but `init()`, if you dont want to build a `CombinedLogger`.
48    ///
49    /// Takes the desired `Level` and `Config` as arguments. They cannot be changed later on.
50    ///
51    /// # Examples
52    /// ```
53    /// # extern crate simplelog;
54    /// # use simplelog::*;
55    /// # fn main() {
56    /// let simple_logger = SimpleLogger::new(LevelFilter::Info, Config::default());
57    /// # }
58    /// ```
59    pub fn new(log_level: LevelFilter, config: Config) -> Box<SimpleLogger> {
60        Box::new(SimpleLogger {
61            level: log_level,
62            config,
63            output_lock: Mutex::new(()),
64        })
65    }
66}
67
68impl Log for SimpleLogger {
69    fn enabled(&self, metadata: &Metadata<'_>) -> bool {
70        metadata.level() <= self.level
71    }
72
73    fn log(&self, record: &Record<'_>) {
74        if self.enabled(record.metadata()) {
75            let _lock = self.output_lock.lock().unwrap();
76
77            match record.level() {
78                Level::Error => {
79                    let stderr = stderr();
80                    let mut stderr_lock = stderr.lock();
81                    let _ = try_log(&self.config, record, &mut stderr_lock);
82                }
83                _ => {
84                    let stdout = stdout();
85                    let mut stdout_lock = stdout.lock();
86                    let _ = try_log(&self.config, record, &mut stdout_lock);
87                }
88            }
89        }
90    }
91
92    fn flush(&self) {
93        use std::io::Write;
94        let _ = stdout().flush();
95    }
96}
97
98impl SharedLogger for SimpleLogger {
99    fn level(&self) -> LevelFilter {
100        self.level
101    }
102
103    fn config(&self) -> Option<&Config> {
104        Some(&self.config)
105    }
106
107    fn as_log(self: Box<Self>) -> Box<dyn Log> {
108        Box::new(*self)
109    }
110}
simplelog/loggers/simplelog.rs

simplelog/loggers/
simplelog.rs
