fmtlog 0.1.4

A simple configurable logger with format specification.
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//! Configuration module.
#[cfg(feature = "colored")]
mod colorize;
mod output;

pub use log::LevelFilter;
pub use output::Output;

#[cfg(feature = "colored")]
pub use colorize::Colorize;

/// The logger settings.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Config {
    #[cfg(feature = "colored")]
    pub(crate) colorize: Colorize,
    pub(crate) format: String,
    pub(crate) level: LevelFilter,
    pub(crate) modules: Vec<String>,
    pub(crate) output: Vec<Output>,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            #[cfg(feature = "colored")]
            colorize: Colorize::default(),

            #[cfg(feature = "chrono")]
            format: String::from(crate::formats::DETAIL1),
            #[cfg(not(feature = "chrono"))]
            format: String::from(crate::formats::SIMPLE1),

            level: LevelFilter::Info,
            modules: Vec::new(),
            output: vec![Output::default()],
        }
    }
}

impl Config {
    /// Create a new instance.
    pub fn new() -> Self {
        Self::default()
    }

    /// [**colored**] Colorize the log.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::Config;
    ///
    /// assert_ne!(Config::new(), Config::new().colorize(false));
    /// ```
    #[cfg(feature = "colored")]
    pub fn colorize<T: Into<Colorize>>(mut self, colorize: T) -> Self {
        self.colorize = colorize.into();
        self
    }

    /// Set the format string.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::Config;
    ///
    /// assert_ne!(Config::new(), Config::new().format("[%L] %M\n"));
    /// ```
    pub fn format<T: Into<String>>(mut self, format: T) -> Self {
        self.format = format.into();
        self
    }

    /// Set the log level.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::{Config, LevelFilter};
    ///
    /// assert_eq!(Config::new(), Config::new().level(LevelFilter::Info))
    /// ```
    pub fn level<T: Into<LevelFilter>>(mut self, level: T) -> Self {
        self.level = level.into();
        self
    }

    /// Set modules that enable the logger.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::{Config, LevelFilter};
    ///
    /// assert_eq!(Config::new(), Config::new().level(LevelFilter::Info))
    /// ```
    pub fn modules<T: IntoIterator>(mut self, modules: T) -> Self
    where
        T::Item: Into<String>,
    {
        self.modules = modules.into_iter().map(|x| x.into()).collect();
        self
    }

    /// Add a module that enables the logger.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::{Config, LevelFilter};
    ///
    /// assert_eq!(Config::new(), Config::new().level(LevelFilter::Info))
    /// ```
    pub fn module<T: Into<String>>(mut self, module: T) -> Self {
        self.modules.push(module.into());
        self
    }

    /// Set the output stream.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::Config;
    ///
    /// assert_ne!(Config::new(), Config::new().output("log.txt"))
    /// ```
    pub fn output<T: Into<Output>>(mut self, output: T) -> Self {
        self.output = vec![output.into()];
        self
    }

    /// Append the output stream.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::{Config, Output};
    ///
    /// assert_eq!(
    ///     Config::new(),
    ///     Config::new().outputs(Vec::<Output>::new()).add_output(Output::Stderr));
    /// ```
    pub fn add_output<T: Into<Output>>(mut self, output: T) -> Self {
        self.output.push(output.into());
        self
    }

    /// Set the output streams.
    ///
    /// # Example
    ///
    /// ```rust
    /// use fmtlog::{Config, Output};
    ///
    /// assert_eq!(Config::new(), Config::new().outputs(vec![Output::Stderr]))
    /// ```
    pub fn outputs<T: IntoIterator>(mut self, outputs: T) -> Self
    where
        T::Item: Into<Output>,
    {
        self.output = outputs.into_iter().map(|x| x.into()).collect();
        self
    }
}