simplelog/loggers/
writelog.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 FileLogger Implementation
9
10use super::logging::try_log;
11use crate::{Config, SharedLogger};
12use log::{set_boxed_logger, set_max_level, LevelFilter, Log, Metadata, Record, SetLoggerError};
13use std::io::Write;
14use std::sync::Mutex;
15
16/// The WriteLogger struct. Provides a Logger implementation for structs implementing `Write`, e.g. File
17pub struct WriteLogger<W: Write + Send + 'static> {
18    level: LevelFilter,
19    config: Config,
20    writable: Mutex<W>,
21}
22
23impl<W: Write + Send + 'static> WriteLogger<W> {
24    /// init function. Globally initializes the WriteLogger as the one and only used log facility.
25    ///
26    /// Takes the desired `Level`, `Config` and `Write` struct as arguments. They cannot be changed later on.
27    /// Fails if another Logger was already initialized.
28    ///
29    /// # Examples
30    /// ```
31    /// # extern crate simplelog;
32    /// # use simplelog::*;
33    /// # use std::fs::File;
34    /// # fn main() {
35    /// let _ = WriteLogger::init(LevelFilter::Info, Config::default(), File::create("my_rust_bin.log").unwrap());
36    /// # }
37    /// ```
38    pub fn init(log_level: LevelFilter, config: Config, writable: W) -> Result<(), SetLoggerError> {
39        set_max_level(log_level);
40        set_boxed_logger(WriteLogger::new(log_level, config, writable))
41    }
42
43    /// allows to create a new logger, that can be independently used, no matter what is globally set.
44    ///
45    /// no macros are provided for this case and you probably
46    /// dont want to use this function, but `init()`, if you dont want to build a `CombinedLogger`.
47    ///
48    /// Takes the desired `Level`, `Config` and `Write` struct as arguments. They cannot be changed later on.
49    ///
50    /// # Examples
51    /// ```
52    /// # extern crate simplelog;
53    /// # use simplelog::*;
54    /// # use std::fs::File;
55    /// # fn main() {
56    /// let file_logger = WriteLogger::new(LevelFilter::Info, Config::default(), File::create("my_rust_bin.log").unwrap());
57    /// # }
58    /// ```
59    pub fn new(log_level: LevelFilter, config: Config, writable: W) -> Box<WriteLogger<W>> {
60        Box::new(WriteLogger {
61            level: log_level,
62            config,
63            writable: Mutex::new(writable),
64        })
65    }
66}
67
68impl<W: Write + Send + 'static> Log for WriteLogger<W> {
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 mut write_lock = self.writable.lock().unwrap();
76            let _ = try_log(&self.config, record, &mut *write_lock);
77        }
78    }
79
80    fn flush(&self) {
81        let _ = self.writable.lock().unwrap().flush();
82    }
83}
84
85impl<W: Write + Send + 'static> SharedLogger for WriteLogger<W> {
86    fn level(&self) -> LevelFilter {
87        self.level
88    }
89
90    fn config(&self) -> Option<&Config> {
91        Some(&self.config)
92    }
93
94    fn as_log(self: Box<Self>) -> Box<dyn Log> {
95        Box::new(*self)
96    }
97}
simplelog/loggers/writelog.rs

simplelog/loggers/
writelog.rs
