terminator 0.2.0-alpha

Formatter for pretty panics and errors
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

use std::env;
use std::ffi::OsStr;

use crate::consts::BACKTRACE;
use crate::consts::LIB_BACKTRACE;

/// Setting for backtrace details
#[derive(Debug, Default, PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Hash)]
pub enum Verbosity {
    /// No backtrace will be collected
    #[default]
    Minimal,
    /// Backtrace will be filtered (influenced by registered [`FrameFilter`](crate::FrameFilter)s)
    Medium,
    /// Backtrace will be shown in full
    Full,
}

impl Verbosity {
    fn decode(thing: &[u8]) -> Option<Self> {
        Some(match thing {
            b"0" => Verbosity::Minimal,
            b"1" => Verbosity::Medium,
            b"full" => Verbosity::Full,
            _ => return None,
        })
    }

    /// Retrieves [`Verbosity`] that should be used by errors based on environment
    pub fn error() -> Option<Self> {
        env::var_os(LIB_BACKTRACE)
            .or_else(|| env::var_os(BACKTRACE))
            .as_deref()
            .map(OsStr::as_encoded_bytes)
            .and_then(Self::decode)
    }

    /// Retrieves [`Verbosity`] that should be used by panics based on environment
    pub fn panic() -> Option<Self> {
        env::var_os(BACKTRACE)
            .as_deref()
            .map(OsStr::as_encoded_bytes)
            .and_then(Self::decode)
    }

    #[allow(unused)]
    pub(crate) fn as_env(self) -> &'static str {
        match self {
            Self::Minimal => "0",
            Self::Medium => "1",
            Self::Full => "full",
        }
    }
}