deboog 0.4.0

Derive macro for extended debug formatting
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
149
150
151
152
153
154
155
156
157
158
159
160

use std::fmt::{self, Debug, Formatter};

use crate::masking::*;

/// Wrapper object to specify type of masking
pub enum Masked<'a, T: DeboogField> {
    /// Replaces all characters with `*`
    All(&'a T),
    /// Same as [`Masked::All`], but leaves unmasked characters according to PAN masking convention
    ///
    /// Leaves 6 characters in the beginning and 4 characters at the end of the string.
    Pan(&'a T),
    /// Replaces all but last four characters with a single `*` symbol
    PanSuffix(&'a T),
    /// Replaces all characters with a fixed string
    Hidden(&'a T),
}

impl<'a, T: DeboogField> Debug for Masked<'a, T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Masked::All(value) => value.fmt_masked(f, MaskType::All),
            Masked::Pan(value) => value.fmt_masked(f, MaskType::Pan),
            Masked::PanSuffix(value) => value.fmt_masked(f, MaskType::PanSuffix),
            Masked::Hidden(_) => write!(f, "{}", HIDE_STR),
        }
    }
}

/// Trait used to produce masked values
pub trait DeboogField {
    /// Writes masked debug value
    #[allow(unused_variables)]
    fn fmt_masked(&self, f: &mut std::fmt::Formatter<'_>, mask_type: MaskType) -> std::fmt::Result {
        write!(f, "{}", HIDE_STR)
    }
}

impl DeboogField for String {
    fn fmt_masked(&self, f: &mut std::fmt::Formatter<'_>, mask_type: MaskType) -> std::fmt::Result {
        let masked = mask(self, mask_type);
        write!(f, "\"{}\"", masked)
    }
}

impl DeboogField for &str {
    fn fmt_masked(&self, f: &mut std::fmt::Formatter<'_>, mask_type: MaskType) -> std::fmt::Result {
        let masked = mask(self, mask_type);
        write!(f, "\"{}\"", masked)
    }
}

impl<T: DeboogField> DeboogField for &T {
    fn fmt_masked(&self, f: &mut std::fmt::Formatter<'_>, mask_type: MaskType) -> std::fmt::Result {
        (*self).fmt_masked(f, mask_type)
    }
}

impl<T: DeboogField> DeboogField for Option<T> {
    fn fmt_masked(&self, f: &mut std::fmt::Formatter<'_>, mask_type: MaskType) -> std::fmt::Result {
        match self {
            Some(ref value) => {
                write!(f, "Some(")?;
                value.fmt_masked(f, mask_type)?;
                write!(f, ")")
            }
            None => write!(f, "None"),
        }
    }
}

impl<T: DeboogField> DeboogField for Vec<T> {
    fn fmt_masked(&self, f: &mut std::fmt::Formatter<'_>, mask_type: MaskType) -> std::fmt::Result {
        let mut first = true;
        write!(f, "[")?;
        for item in self {
            if first {
                first = false;
            } else {
                write!(f, ", ")?;
            }
            item.fmt_masked(f, mask_type)?;
        }
        write!(f, "]")
    }
}

macro_rules! display_impl {
    ($t:ty) => {
        impl DeboogField for $t {
            fn fmt_masked(
                &self,
                f: &mut std::fmt::Formatter<'_>,
                mask_type: MaskType,
            ) -> std::fmt::Result {
                let plain = format!("{}", self);
                write!(f, "{}", mask(&plain, mask_type))
            }
        }
    };
}

// Any other masking strategy is pointless for boolean type.
impl DeboogField for bool {}

display_impl!(i8);
display_impl!(i16);
display_impl!(i32);
display_impl!(i64);
display_impl!(i128);
display_impl!(isize);

display_impl!(u8);
display_impl!(u16);
display_impl!(u32);
display_impl!(u64);
display_impl!(u128);
display_impl!(usize);

display_impl!(f32);
display_impl!(f64);

display_impl!(std::num::NonZeroI8);
display_impl!(std::num::NonZeroI16);
display_impl!(std::num::NonZeroI32);
display_impl!(std::num::NonZeroI64);
display_impl!(std::num::NonZeroI128);
display_impl!(std::num::NonZeroIsize);

display_impl!(std::num::NonZeroU8);
display_impl!(std::num::NonZeroU16);
display_impl!(std::num::NonZeroU32);
display_impl!(std::num::NonZeroU64);
display_impl!(std::num::NonZeroU128);
display_impl!(std::num::NonZeroUsize);

#[cfg(feature = "chrono")]
mod chrono_fields {
    use super::*;

    display_impl!(chrono::Weekday);
    display_impl!(chrono::NaiveDate);
    display_impl!(chrono::NaiveTime);
    display_impl!(chrono::NaiveDateTime);

    impl<Tz> DeboogField for chrono::DateTime<Tz>
    where
        Tz: chrono::TimeZone,
        Tz::Offset: std::fmt::Display,
    {
        fn fmt_masked(
            &self,
            f: &mut std::fmt::Formatter<'_>,
            mask_type: MaskType,
        ) -> std::fmt::Result {
            let plain = self.to_rfc3339();
            write!(f, "{}", mask(&plain, mask_type))
        }
    }
}