src/handlers/handler.rs

Lines

100.00 %

Functions

100.00 %

Regions

100.00 %


//
// File Name:    handler.rs
// Directory:    src/handlers
// 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/>.
//

//!
//! # Handler
//!

// #![allow(unused)]
pub mod handler_trait;

use std::{fmt, hash::Hash, io::Error};
pub use handler_trait::HandlerTrait;

///
/// Available handlers.
///
#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
pub enum Handler {
    ///
    /// Refers to the `ConsoleHandler` => `ConsoleType::StdOut`.
    ///
    #[default]
    Console,
    ///
    /// Refers to the `ConsoleHandler` => `ConsoleType::StdErr`.
    ///
    EConsole,
    ///
    /// Refers to the `FileHandler`.
    ///
    File,
    ///
    /// Refers to the `ConsoleHandler` => `ConsoleType::Production`.
    ///
    PConsole,
    ///
    /// Refers to the `StringHandler`.
    ///
    String,
    ///
    /// Refers to a custom handler; by default: `MockHandler`.
    ///
    Custom(String),
}

impl fmt::Display for Handler {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let text = match &self {
            Handler::Console => "Console",
            Handler::EConsole => "EConsole",
            Handler::File => "File",
            Handler::PConsole => "PConsole",
            Handler::String => "String",
            Handler::Custom(label) => &format!("Custom({label})"),
        };

        write!(f, "Handler::{text}")
    }
}

#[cfg(test)]
mod test {
    use super::Handler;

    #[test]
    fn handlers() {
        let console = Handler::Console;
        let econsole = Handler::EConsole;
        let pconsole = Handler::PConsole;
        let file = Handler::File;
        let string = Handler::String;
        let custom = Handler::Custom("MyCustom".to_string());

        assert_eq!(console.to_string(), "Handler::Console".to_string());
        assert_eq!(econsole.to_string(), "Handler::EConsole".to_string());
        assert_eq!(pconsole.to_string(), "Handler::PConsole".to_string());
        assert_eq!(file.to_string(), "Handler::File".to_string());
        assert_eq!(string.to_string(), "Handler::String".to_string());
        assert_eq!(custom.to_string(), "Handler::Custom(MyCustom)".to_string());
    }
}

Line	Count	Source (jump to first uncovered line)
1		//
2		// File Name: handler.rs
3		// Directory: src/handlers
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		//! # Handler
26		//!
27
28		// #![allow(unused)]
29		pub mod handler_trait;
30
31		use std::{fmt, hash::Hash, io::Error};
32		pub use handler_trait::HandlerTrait;
33
34		///
35		/// Available handlers.
36		///
37		#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
38		pub enum Handler {
39		///
40		/// Refers to the `ConsoleHandler` => `ConsoleType::StdOut`.
41		///
42		#[default]
43		Console,
44		///
45		/// Refers to the `ConsoleHandler` => `ConsoleType::StdErr`.
46		///
47		EConsole,
48		///
49		/// Refers to the `FileHandler`.
50		///
51		File,
52		///
53		/// Refers to the `ConsoleHandler` => `ConsoleType::Production`.
54		///
55		PConsole,
56		///
57		/// Refers to the `StringHandler`.
58		///
59		String,
60		///
61		/// Refers to a custom handler; by default: `MockHandler`.
62		///
63		Custom(String),
64		}
65
66		impl fmt::Display for Handler {
67	10	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
68	10	let text = match &self {
69	2	Handler::Console => "Console",
70	1	Handler::EConsole => "EConsole",
71	2	Handler::File => "File",
72	1	Handler::PConsole => "PConsole",
73	2	Handler::String => "String",
74	2	Handler::Custom(label) => &format!("Custom({label})"),
75		};
76
77	10	write!(f, "Handler::{text}")
78	10	}
79		}
80
81		#[cfg(test)]
82		mod test {
83		use super::Handler;
84
85		#[test]
86	1	fn handlers() {
87	1	let console = Handler::Console;
88	1	let econsole = Handler::EConsole;
89	1	let pconsole = Handler::PConsole;
90	1	let file = Handler::File;
91	1	let string = Handler::String;
92	1	let custom = Handler::Custom("MyCustom".to_string());
93
94	1	assert_eq!(console.to_string(), "Handler::Console".to_string());
95	1	assert_eq!(econsole.to_string(), "Handler::EConsole".to_string());
96	1	assert_eq!(pconsole.to_string(), "Handler::PConsole".to_string());
97	1	assert_eq!(file.to_string(), "Handler::File".to_string());
98	1	assert_eq!(string.to_string(), "Handler::String".to_string());
99	1	assert_eq!(custom.to_string(), "Handler::Custom(MyCustom)".to_string());
100	1	}
101		}