flogging 0.6.0

This is a fast, flexible logging crate, loosely based on the Java logging package: java.util.logging.
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

//
// File Name:    mock_handler.rs
// 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/>.
//

//!
//! # Mock Handler
//!
//! Returned as Default for Custom handler that is missing.
//!

use crate::*;
use std::{
    fmt,
    io::{self, Error},
};

///
/// This is used as a _fake_ or _mock_ handler.
///
/// It is a filler for `Handler::Custom(label).create()`. It is also used
/// in examples for custom handlers.
///
#[derive(Debug, Default)]
pub struct MockHandler {}

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

impl HandlerTrait for MockHandler {
    fn create(_name: &str) -> Result<Self, Error>
    where
        Self: Sized,
    {
        Ok(Default::default())
    }

    ///
    /// This is a 'NoOp' fn.
    ///
    fn close(&mut self) {}

    ///
    /// This is a 'NoOp' fn.
    ///
    fn flush(&mut self) {}

    fn get_formatter(&self) -> Formatter {
        Default::default()
    }

    fn get_log(&self) -> String {
        Default::default()
    }

    ///
    /// This is always `false`.
    ///
    fn is_open(&self) -> bool {
        false
    }

    #[allow(private_interfaces)]
    fn publish(&mut self, _log_entry: &LogEntry) {}

    fn set_formatter(&mut self, _formatter: Formatter) {}

    ///
    /// This is a 'NoOp' fn.
    ///
    fn set_test_mode(&mut self, _state: bool) {}
}

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

    use crate::{Handler, Logger, logger};

    #[test]
    fn handler_trait() {
        let mut log = Logger::custom_logger(
            module_path!(),
            "Mock",
            Box::new(MockHandler::create(module_path!()).unwrap()),
        );

        // println!("{log}");
        assert_eq!("flogging::handlers::mock_handler::tests:: - [INFO]\n\nHandler::Custom(Mock): MockHandler!!\n\n".to_string(), log.to_string());
        log.info("trait methods");
        log.warning("The sky is falling!");

        let handler = log
            .get_handler(crate::Handler::Custom("Mock".to_string()))
            .unwrap();

        handler.set_test_mode(true);

        assert!(!handler.is_open());

        handler.set_formatter(FormatType::Simple.create(None));

        assert_eq!(
            handler.get_formatter().to_string(),
            "dt_fmt: \"\" - fmt_string: \"{mod_path}->{fn_name} [{level:7}] {message}\""
                .to_string()
        );

        assert_eq!(handler.get_log(), "".to_string());

        handler.flush();
        assert_eq!(handler.get_log(), "".to_string());
        handler.close();
    }
}