bp3d_debug/logger/
level.rs

1// Copyright (c) 2024, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use std::fmt::{Display, Formatter};
30
31/// An enum representing the available verbosity levels for a message.
32#[repr(u8)]
33#[derive(Clone, PartialEq, Copy, Ord, PartialOrd, Eq, Debug, Hash)]
34pub enum Level {
35    /// The "trace" level.
36    ///
37    /// Designates very low priority, often extremely verbose, information.
38    Trace = 1,
39
40    /// The "debug" level.
41    ///
42    /// Designates lower priority information.
43    Debug = 2,
44
45    /// The "info" level.
46    ///
47    /// Designates useful information.
48    Info = 3,
49
50    /// The "warn" level.
51    ///
52    /// Designates hazardous situations.
53    Warn = 4,
54
55    /// The "error" level.
56    ///
57    /// Designates very serious errors.
58    // This way these line up with the discriminants for LevelFilter below
59    // This works because Rust treats field-less enums the same way as C does:
60    // https://doc.rust-lang.org/reference/items/enumerations.html#custom-discriminant-values-for-field-less-enumerations
61    Error = 5,
62}
63
64static LOG_LEVEL_NAMES: [&str; 6] = ["OFF", "TRACE", "DEBUG", "INFO", "WARNING", "ERROR"];
65
66impl Level {
67    /// Returns the string representation of the `Level`.
68    ///
69    /// This returns the same string as the `fmt::Display` implementation.
70    pub fn as_str(&self) -> &'static str {
71        LOG_LEVEL_NAMES[*self as usize]
72    }
73}
74
75impl Display for Level {
76    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
77        f.write_str(self.as_str())
78    }
79}
bp3d_debug/logger/level.rs

bp3d_debug/logger/
level.rs
