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
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
136
137
138
139
140
141
142
143
144
145
146
147
148

use core::fmt::{Debug, Display, Formatter, Result as FmtResult};

/// An utility wrapper type which is used to forward both [`core::fmt::Debug`]
/// and [`core::fmt::Display`] value implementations to its
/// [`core::fmt::Display`] implementation.
///
/// # Examples
///
/// ```rust
/// use unwind_context::{unwind_context, WithDisplay};
///
/// fn func(value: impl core::fmt::Display) {
///     let _ctx = unwind_context!(fn(WithDisplay(value)));
///     // ...
/// }
/// ```
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Default)]
pub struct WithDisplay<T>(
    /// The wrapped value to be formatted with [`core::fmt::Display`] regardless
    /// of whether formatting is invoked with [`core::fmt::Debug`] or
    /// [`core::fmt::Display`] formatter.
    pub T,
);

/// An utility wrapper type which is used to forward both [`core::fmt::Debug`]
/// and [`core::fmt::Display`] value implementations to its [`core::fmt::Debug`]
/// implementation with pretty flag.
///
/// # Examples
///
/// ```rust
/// use unwind_context::{unwind_context, WithPrettyDebug};
///
/// fn func(long_json: impl core::fmt::Debug) {
///     let _ctx = unwind_context!(fn(WithPrettyDebug(long_json)));
///     // ...
/// }
/// ```
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Default)]
pub struct WithPrettyDebug<T>(
    /// The wrapped value to be formatted with pretty
    /// [`core::fmt::Debug`] variant regardless of whether formatting is
    /// invoked with [`core::fmt::Debug`] or [`core::fmt::Display`]
    /// formatter.
    pub T,
);

impl<T> Display for WithDisplay<T>
where
    T: Display,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        Display::fmt(&self.0, f)
    }
}

impl<T> Debug for WithDisplay<T>
where
    T: Display,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        Display::fmt(&self.0, f)
    }
}

impl<T> Display for WithPrettyDebug<T>
where
    T: Debug,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "{:#?}", self.0)
    }
}

impl<T> Debug for WithPrettyDebug<T>
where
    T: Debug,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "{:#?}", self.0)
    }
}

#[cfg(test)]
mod tests {
    use crate::test_util::buf_fmt;
    use crate::{WithDisplay, WithPrettyDebug};

    #[derive(Clone, Debug)]
    struct Struct {
        _first: u32,
        _second: &'static str,
    }

    #[test]
    fn test_debug_with_display() {
        let mut buffer = [0; 16];
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{}", "foo\nbar")),
            Ok("foo\nbar")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{:?}", "foo\nbar")),
            Ok("\"foo\\nbar\"")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{}", WithDisplay("foo\nbar"))),
            Ok("foo\nbar")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{:?}", WithDisplay("foo\nbar"))),
            Ok("foo\nbar")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{:#?}", WithDisplay("foo\nbar"))),
            Ok("foo\nbar")
        );
    }

    #[test]
    fn test_debug_with_pretty_debug() {
        let value = Struct {
            _first: 1,
            _second: "foo\nbar",
        };
        let mut buffer = [0; 64];
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{value:?}")),
            Ok("Struct { _first: 1, _second: \"foo\\nbar\" }")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{value:#?}")),
            Ok("Struct {\n    _first: 1,\n    _second: \"foo\\nbar\",\n}")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{}", WithPrettyDebug(&value))),
            Ok("Struct {\n    _first: 1,\n    _second: \"foo\\nbar\",\n}")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{:?}", WithPrettyDebug(&value))),
            Ok("Struct {\n    _first: 1,\n    _second: \"foo\\nbar\",\n}")
        );
        assert_eq!(
            buf_fmt(&mut buffer, format_args!("{:#?}", WithPrettyDebug(&value))),
            Ok("Struct {\n    _first: 1,\n    _second: \"foo\\nbar\",\n}")
        );
    }
}