unwind-context 0.2.2

Macro to add colored panic context to your functions
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

/// The default ANSI color scheme, which is used if colorization is enabled but
/// no custom color scheme is set.
///
/// # Examples
#[cfg_attr(feature = "custom-default-colors", doc = "```rust")]
#[cfg_attr(not(feature = "custom-default-colors"), doc = "```rust,compile_fail")]
/// static CUSTOM_DEFAULT_COLOR_SCHEME: unwind_context::AnsiColorScheme =
///     unwind_context::AnsiColorScheme {
///         item: "\u{1b}[37m",
///         ..unwind_context::DEFAULT_DEFAULT_COLOR_SCHEME
///     };
///
/// unwind_context::set_default_color_scheme(&CUSTOM_DEFAULT_COLOR_SCHEME);
#[doc = "```"]
pub static DEFAULT_DEFAULT_COLOR_SCHEME: AnsiColorScheme = AnsiColorScheme {
    default: "\u{1b}[0m",
    location: "\u{1b}[94m",
    fn_keyword: "\u{1b}[33m",
    func_name: "\u{1b}[93m",
    func_braces: "\u{1b}[0m",
    value_braces: "\u{1b}[0m",
    ident: "\u{1b}[0;33m",
    item: "\u{1b}[0;33m",
    boolean: "\u{1b}[1;93m",
    number: "\u{1b}[0;96m",
    quoted: "\u{1b}[0;32m",
    escaped: "\u{1b}[0;95m",
};

#[doc(hidden)]
#[deprecated(since = "0.2.0", note = "renamed to `DEFAULT_DEFAULT_COLOR_SCHEME`.")]
pub use DEFAULT_DEFAULT_COLOR_SCHEME as DEFAULT_ANSI_COLOR_SCHEME;

/// A structure representing an ANSI color scheme used by [`DebugAnsiColored`]
/// formatter.
///
/// # Examples
#[cfg_attr(feature = "custom-default-colors", doc = "```rust")]
#[cfg_attr(not(feature = "custom-default-colors"), doc = "```rust,compile_fail")]
/// unwind_context::set_default_color_scheme(&unwind_context::AnsiColorScheme {
///     default: "\u{1b}[0m",
///     location: "\u{1b}[31m",
///     fn_keyword: "\u{1b}[32m",
///     func_name: "\u{1b}[33m",
///     func_braces: "\u{1b}[34m",
///     value_braces: "\u{1b}[35m",
///     ident: "\u{1b}[36m",
///     item: "\u{1b}[37m",
///     boolean: "\u{1b}[91m",
///     number: "\u{1b}[92m",
///     quoted: "\u{1b}[93m",
///     escaped: "\u{1b}[94m",
/// });
#[doc = "```"]
#[doc = ""]
/// [`DebugAnsiColored`]: crate::DebugAnsiColored
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub struct AnsiColorScheme {
    /// The ANSI escape sequence used for default text styling.
    pub default: &'static str,
    /// The ANSI escape sequence used before code location.
    pub location: &'static str,
    /// The ANSI escape sequence used before `fn` keyword.
    pub fn_keyword: &'static str,
    /// The ANSI escape sequence used before function name.
    pub func_name: &'static str,
    /// The ANSI escape sequence used before function braces.
    pub func_braces: &'static str,
    /// The ANSI escape sequence used before any value braces.
    pub value_braces: &'static str,
    /// The ANSI escape sequence used before identifiers.
    pub ident: &'static str,
    /// The ANSI escape sequence used before struct, enum and const names.
    pub item: &'static str,
    /// The ANSI escape sequence used before `false` or `true` keywords.
    pub boolean: &'static str,
    /// The ANSI escape sequence used before numbers.
    pub number: &'static str,
    /// The ANSI escape sequence used before quoted strings.
    pub quoted: &'static str,
    /// The ANSI escape sequence used before escaped characters in quoted
    /// strings.
    pub escaped: &'static str,
}