starbase 0.12.0

Framework for building performant command line applications and developer tools.
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

use super::TracingError;
use std::fmt;
use std::str::FromStr;
use tracing::Level;

/// This is similar to [`tracing::Level`] but provides "Off" and "Verbose" variants.
#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
pub enum LogLevel {
    Off,
    Error,
    Warn,
    #[default]
    Info,
    Debug,
    Trace,
    /// Like `Trace`, but also includes all modules and spans.
    Verbose,
}

impl LogLevel {
    /// Returns `true` if the log level is `Off`, meaning no messages will be logged.
    pub fn is_off(&self) -> bool {
        matches!(self, Self::Off)
    }

    /// Returns `true` if the log level is `Verbose`, meaning all messages will be logged.
    pub fn is_verbose(&self) -> bool {
        matches!(self, Self::Verbose)
    }

    /// Converts the `LogLevel` to an optional [`tracing::Level`].
    pub fn to_tracing_level(&self) -> Option<Level> {
        match self {
            Self::Off => None,
            Self::Error => Some(Level::ERROR),
            Self::Warn => Some(Level::WARN),
            Self::Info => Some(Level::INFO),
            Self::Debug => Some(Level::DEBUG),
            Self::Trace | Self::Verbose => Some(Level::TRACE),
        }
    }
}

impl fmt::Display for LogLevel {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        write!(
            f,
            "{}",
            match self {
                Self::Off => "off",
                Self::Error => "error",
                Self::Warn => "warn",
                Self::Info => "info",
                Self::Debug => "debug",
                Self::Trace => "trace",
                Self::Verbose => "verbose",
            }
        )
    }
}

impl TryFrom<String> for LogLevel {
    type Error = TracingError;

    fn try_from(value: String) -> Result<Self, TracingError> {
        Self::from_str(value.as_str())
    }
}

impl TryFrom<&str> for LogLevel {
    type Error = TracingError;

    fn try_from(value: &str) -> Result<Self, TracingError> {
        Self::from_str(value)
    }
}

impl FromStr for LogLevel {
    type Err = TracingError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Ok(match value.to_lowercase().as_str() {
            "off" => Self::Off,
            "error" => Self::Error,
            "warn" => Self::Warn,
            "info" => Self::Info,
            "debug" => Self::Debug,
            "trace" => Self::Trace,
            "verbose" => Self::Verbose,
            other => {
                return Err(TracingError::LogLevelInvalid {
                    level: other.to_string(),
                });
            }
        })
    }
}