simplelog/
config.rs

Help
1#[cfg(feature = "termcolor")]
2use log::Level;
3use log::LevelFilter;
4
5pub use chrono::offset::{FixedOffset, Local, Offset, TimeZone, Utc};
6use std::borrow::Cow;
7#[cfg(feature = "termcolor")]
8use termcolor::Color;
9
10#[derive(Debug, Clone, Copy)]
11/// Padding to be used for logging the level
12pub enum LevelPadding {
13    /// Add spaces on the left side
14    Left,
15    /// Add spaces on the right side
16    Right,
17    /// Do not pad the level
18    Off,
19}
20
21#[derive(Debug, Clone, Copy)]
22/// Padding to be used for logging the thread id/name
23pub enum ThreadPadding {
24    /// Add spaces on the left side, up to usize many
25    Left(usize),
26    /// Add spaces on the right side, up to usize many
27    Right(usize),
28    /// Do not pad the thread id/name
29    Off,
30}
31
32#[derive(Debug, Clone, Copy, PartialEq)]
33/// Mode for logging the thread name or id or both.
34pub enum ThreadLogMode {
35    /// Log thread ids only
36    IDs,
37    /// Log the thread names only
38    Names,
39    /// If this thread is named, log the name. Otherwise, log the thread id.
40    Both,
41}
42
43/// Configuration for the Loggers
44///
45/// All loggers print the message in the following form:
46/// `00:00:00 [LEVEL] crate::module: [lib.rs::100] your_message`
47/// Every space delimited part except the actual message is optional.
48///
49/// Pass this struct to your logger to change when these information shall
50/// be logged.
51///
52/// Construct using `Default` or using `ConfigBuilder`
53#[derive(Debug, Clone)]
54pub struct Config {
55    pub(crate) time: LevelFilter,
56    pub(crate) level: LevelFilter,
57    pub(crate) level_padding: LevelPadding,
58    pub(crate) thread: LevelFilter,
59    pub(crate) thread_log_mode: ThreadLogMode,
60    pub(crate) thread_padding: ThreadPadding,
61    pub(crate) target: LevelFilter,
62    pub(crate) location: LevelFilter,
63    pub(crate) time_format: Cow<'static, str>,
64    pub(crate) time_offset: FixedOffset,
65    pub(crate) time_local: bool,
66    pub(crate) filter_allow: Cow<'static, [Cow<'static, str>]>,
67    pub(crate) filter_ignore: Cow<'static, [Cow<'static, str>]>,
68    #[cfg(feature = "termcolor")]
69    pub(crate) level_color: [Option<Color>; 6],
70}
71
72/// Builder for the Logger Configurations (`Config`)
73///
74/// All loggers print the message in the following form:
75/// `00:00:00 [LEVEL] crate::module: [lib.rs::100] your_message`
76/// Every space delimited part except the actual message is optional.
77///
78/// Use this struct to create a custom `Config` changing when these information shall
79/// be logged. Every part can be enabled for a specific Level and is then
80/// automatically enable for all lower levels as well.
81///
82/// The Result is that the logging gets more detailed the more verbose it gets.
83/// E.g. to have one part shown always use `Level::Error`. But if you
84/// want to show the source line only on `Trace` use that.
85#[derive(Debug, Clone)]
86#[non_exhaustive]
87pub struct ConfigBuilder(Config);
88
89impl ConfigBuilder {
90    /// Create a new default ConfigBuilder
91    pub fn new() -> ConfigBuilder {
92        ConfigBuilder(Config::default())
93    }
94
95    /// Set at which level and above (more verbose) the level itself shall be logged (default is Error)
96    pub fn set_max_level(&mut self, level: LevelFilter) -> &mut ConfigBuilder {
97        self.0.level = level;
98        self
99    }
100
101    /// Set at which level and  above (more verbose) the current time shall be logged (default is Error)
102    pub fn set_time_level(&mut self, time: LevelFilter) -> &mut ConfigBuilder {
103        self.0.time = time;
104        self
105    }
106
107    /// Set at which level and above (more verbose) the thread id shall be logged. (default is Debug)
108    pub fn set_thread_level(&mut self, thread: LevelFilter) -> &mut ConfigBuilder {
109        self.0.thread = thread;
110        self
111    }
112
113    /// Set at which level and above (more verbose) the target shall be logged. (default is Debug)
114    pub fn set_target_level(&mut self, target: LevelFilter) -> &mut ConfigBuilder {
115        self.0.target = target;
116        self
117    }
118
119    /// Set at which level and above (more verbose) a source code reference shall be logged (default is Trace)
120    pub fn set_location_level(&mut self, location: LevelFilter) -> &mut ConfigBuilder {
121        self.0.location = location;
122        self
123    }
124
125    /// Set how the levels should be padded, when logging (default is Off)
126    pub fn set_level_padding(&mut self, padding: LevelPadding) -> &mut ConfigBuilder {
127        self.0.level_padding = padding;
128        self
129    }
130
131    /// Set how the thread should be padded
132    pub fn set_thread_padding(&mut self, padding: ThreadPadding) -> &mut ConfigBuilder {
133        self.0.thread_padding = padding;
134        self
135    }
136
137    /// Set the mode for logging the thread
138    pub fn set_thread_mode(&mut self, mode: ThreadLogMode) -> &mut ConfigBuilder {
139        self.0.thread_log_mode = mode;
140        self
141    }
142
143    /// Set the color used for printing the level (if the logger supports it),
144    /// or None to use the default foreground color
145    #[cfg(feature = "termcolor")]
146    pub fn set_level_color(&mut self, level: Level, color: Option<Color>) -> &mut ConfigBuilder {
147        self.0.level_color[level as usize] = color;
148        self
149    }
150
151    /// Set time chrono [strftime] format string.
152    ///
153    /// [strftime]: https://docs.rs/chrono/0.4.0/chrono/format/strftime/index.html#specifiers
154    pub fn set_time_format_str(&mut self, time_format: &'static str) -> &mut ConfigBuilder {
155        self.0.time_format = Cow::Borrowed(time_format);
156        self
157    }
158
159    /// Set time chrono [strftime] format string.
160    ///
161    /// [strftime]: https://docs.rs/chrono/0.4.0/chrono/format/strftime/index.html#specifiers
162    pub fn set_time_format(&mut self, time_format: String) -> &mut ConfigBuilder {
163        self.0.time_format = Cow::Owned(time_format);
164        self
165    }
166
167    /// Set offset used for logging time (default is 0)
168    pub fn set_time_offset(&mut self, time_offset: FixedOffset) -> &mut ConfigBuilder {
169        self.0.time_offset = time_offset;
170        self
171    }
172
173    /// set if you log in local timezone or UTC (default is UTC)
174    pub fn set_time_to_local(&mut self, local: bool) -> &mut ConfigBuilder {
175        self.0.time_local = local;
176        self
177    }
178
179    /// Add allowed module filters.
180    /// If any are specified, only records from modules starting with one of these entries will be printed
181    ///
182    /// For example, `add_filter_allow_str("tokio::uds")` would allow only logging from the `tokio` crates `uds` module.
183    pub fn add_filter_allow_str(&mut self, filter_allow: &'static str) -> &mut ConfigBuilder {
184        let mut list = Vec::from(&*self.0.filter_allow);
185        list.push(Cow::Borrowed(filter_allow));
186        self.0.filter_allow = Cow::Owned(list);
187        self
188    }
189
190    /// Add allowed module filters.
191    /// If any are specified, only records from modules starting with one of these entries will be printed
192    ///
193    /// For example, `add_filter_allow(format!("{}{}","tokio", "uds"))` would allow only logging from the `tokio` crates `uds` module.
194    pub fn add_filter_allow(&mut self, filter_allow: String) -> &mut ConfigBuilder {
195        let mut list = Vec::from(&*self.0.filter_allow);
196        list.push(Cow::Owned(filter_allow));
197        self.0.filter_allow = Cow::Owned(list);
198        self
199    }
200
201    /// Clear allowed module filters.
202    /// If none are specified, nothing is filtered out
203    pub fn clear_filter_allow(&mut self) -> &mut ConfigBuilder {
204        self.0.filter_allow = Cow::Borrowed(&[]);
205        self
206    }
207
208    /// Add denied module filters.
209    /// If any are specified, records from modules starting with one of these entries will be ignored
210    ///
211    /// For example, `add_filter_ignore_str("tokio::uds")` would deny logging from the `tokio` crates `uds` module.
212    pub fn add_filter_ignore_str(&mut self, filter_ignore: &'static str) -> &mut ConfigBuilder {
213        let mut list = Vec::from(&*self.0.filter_ignore);
214        list.push(Cow::Borrowed(filter_ignore));
215        self.0.filter_ignore = Cow::Owned(list);
216        self
217    }
218
219    /// Add denied module filters.
220    /// If any are specified, records from modules starting with one of these entries will be ignored
221    ///
222    /// For example, `add_filter_ignore(format!("{}{}","tokio", "uds"))` would deny logging from the `tokio` crates `uds` module.
223    pub fn add_filter_ignore(&mut self, filter_ignore: String) -> &mut ConfigBuilder {
224        let mut list = Vec::from(&*self.0.filter_ignore);
225        list.push(Cow::Owned(filter_ignore));
226        self.0.filter_ignore = Cow::Owned(list);
227        self
228    }
229
230    /// Clear ignore module filters.
231    /// If none are specified, nothing is filtered
232    pub fn clear_filter_ignore(&mut self) -> &mut ConfigBuilder {
233        self.0.filter_ignore = Cow::Borrowed(&[]);
234        self
235    }
236
237    /// Build new `Config`
238    pub fn build(&mut self) -> Config {
239        self.0.clone()
240    }
241}
242
243impl Default for ConfigBuilder {
244    fn default() -> Self {
245        ConfigBuilder::new()
246    }
247}
248
249impl Default for Config {
250    fn default() -> Config {
251        Config {
252            time: LevelFilter::Error,
253            level: LevelFilter::Error,
254            level_padding: LevelPadding::Off,
255            thread: LevelFilter::Debug,
256            thread_log_mode: ThreadLogMode::IDs,
257            thread_padding: ThreadPadding::Off,
258            target: LevelFilter::Debug,
259            location: LevelFilter::Trace,
260            time_format: Cow::Borrowed("%H:%M:%S"),
261            time_offset: FixedOffset::east(0),
262            time_local: false,
263            filter_allow: Cow::Borrowed(&[]),
264            filter_ignore: Cow::Borrowed(&[]),
265
266            #[cfg(feature = "termcolor")]
267            level_color: [
268                None,                // Default foreground
269                Some(Color::Red),    // Error
270                Some(Color::Yellow), // Warn
271                Some(Color::Blue),   // Info
272                Some(Color::Cyan),   // Debug
273                Some(Color::White),  // Trace
274            ],
275        }
276    }
277}
simplelog/config.rs

simplelog/
config.rs
