src/handlers/formatters/simple

src/handlers/formatters/simple_formatter.rs

Lines

100.00 %

Functions

100.00 %

Regions

100.00 %


//
// File Name:    simple_formatter.rs
// Directory:    src/handlers/formatters
// Project Name: flogging
//
// Copyright (C) 2025 Bradley Willcott
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
// This library (crate) is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This library (crate) is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this library (crate).  If not, see <https://www.gnu.org/licenses/>.
//

//!
//! # Simple Formatter
//!

use std::fmt;
use crate::FormatTrait;

///
/// Simple format.
///
/// Template:
/// - `mod_path`, `fn_name`, `level`, and `message` all come out of the `LogEntry`
///   provided to the [`format()`][SimpleFormatter::format] method.
/// ```ignore
/// format!("{mod_path}->{fn_name} [{level:7}] {message}");
/// ```
/// Sample output:
/// ```text
/// flogging->main [INFO   ] It is cloudy today.
/// ```
///

#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub struct SimpleFormatter {
    dt_fmt: String,
    fmt_string: String,
}

impl SimpleFormatter {
    ///
    /// Creates a new instance of `SimpleFormatter`.
    ///
    pub fn new() -> Self {
        Self {
            dt_fmt: "".to_string(),
            fmt_string: "{mod_path}->{fn_name} [{level:7}] {message}".to_string(),
        }
    }

    ///
    /// Returns the date/time format string.
    ///
    pub fn dt_fmt(&self) -> String {
        self.dt_fmt.clone()
    }

    ///
    /// Returns the primary format string.
    ///
    pub fn fmt_string(&self) -> String {
        self.fmt_string.clone()
    }
}

impl Default for SimpleFormatter {
    fn default() -> Self {
        Self::new()
    }
}

impl fmt::Display for SimpleFormatter {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "dt_fmt: \"{}\" - fmt_string: \"{}\"",
            self.dt_fmt, self.fmt_string
        )
    }
}

impl FormatTrait for SimpleFormatter {
    fn format(&self, log_entry: &crate::LogEntry) -> String {
        self.ft_fmt(self.dt_fmt(), self.fmt_string(), log_entry)
    }
}

Line	Count	Source
1		//
2		// File Name: simple_formatter.rs
3		// Directory: src/handlers/formatters
4		// Project Name: flogging
5		//
6		// Copyright (C) 2025 Bradley Willcott
7		//
8		// SPDX-License-Identifier: GPL-3.0-or-later
9		//
10		// This library (crate) is free software: you can redistribute it and/or modify
11		// it under the terms of the GNU General Public License as published by
12		// the Free Software Foundation, either version 3 of the License, or
13		// (at your option) any later version.
14		//
15		// This library (crate) is distributed in the hope that it will be useful,
16		// but WITHOUT ANY WARRANTY; without even the implied warranty of
17		// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		// GNU General Public License for more details.
19		//
20		// You should have received a copy of the GNU General Public License
21		// along with this library (crate). If not, see <https://www.gnu.org/licenses/>.
22		//
23
24		//!
25		//! # Simple Formatter
26		//!
27
28		use std::fmt;
29		use crate::FormatTrait;
30
31		///
32		/// Simple format.
33		///
34		/// Template:
35		/// - `mod_path`, `fn_name`, `level`, and `message` all come out of the `LogEntry`
36		/// provided to the [`format()`][SimpleFormatter::format] method.
37		/// ```ignore
38		/// format!("{mod_path}->{fn_name} [{level:7}] {message}");
39		/// ```
40		/// Sample output:
41		/// ```text
42		/// flogging->main [INFO ] It is cloudy today.
43		/// ```
44		///
45
46		#[derive(Debug, Clone, Hash, PartialEq, Eq)]
47		pub struct SimpleFormatter {
48		dt_fmt: String,
49		fmt_string: String,
50		}
51
52		impl SimpleFormatter {
53		///
54		/// Creates a new instance of `SimpleFormatter`.
55		///
56	52	pub fn new() -> Self {
57	52	Self {
58	52	dt_fmt: "".to_string(),
59	52	fmt_string: "{mod_path}->{fn_name} [{level:7}] {message}".to_string(),
60	52	}
61	52	}
62
63		///
64		/// Returns the date/time format string.
65		///
66	92	pub fn dt_fmt(&self) -> String {
67	92	self.dt_fmt.clone()
68	92	}
69
70		///
71		/// Returns the primary format string.
72		///
73	92	pub fn fmt_string(&self) -> String {
74	92	self.fmt_string.clone()
75	92	}
76		}
77
78		impl Default for SimpleFormatter {
79	50	fn default() -> Self {
80	50	Self::new()
81	50	}
82		}
83
84		impl fmt::Display for SimpleFormatter {
85	18	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
86	18	write!(
87	18	f,
88	18	"dt_fmt: \"{}\" - fmt_string: \"{}\"",
89		self.dt_fmt, self.fmt_string
90		)
91	18	}
92		}
93
94		impl FormatTrait for SimpleFormatter {
95	92	fn format(&self, log_entry: &crate::LogEntry) -> String {
96	92	self.ft_fmt(self.dt_fmt(), self.fmt_string(), log_entry)
97	92	}
98		}