redactable 0.10.1

Automatic redaction of sensitive data in structs for safe logging and debugging
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

//! Redaction traversal for wrapper container types.

use std::{
    collections::VecDeque,
    sync::{Mutex, RwLock},
};

use crate::redaction::{redact::RedactableMapper, traits::RedactableWithMapper};

// =============================================================================
// Wrapper container implementations
// =============================================================================

impl<T> RedactableWithMapper for Option<T>
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        self.map(|value| value.redact_with(mapper))
    }
}

impl<T, E> RedactableWithMapper for Result<T, E>
where
    T: RedactableWithMapper,
    E: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        match self {
            Ok(value) => Ok(value.redact_with(mapper)),
            Err(err) => Err(err.redact_with(mapper)),
        }
    }
}

impl<T> RedactableWithMapper for Vec<T>
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        self.into_iter()
            .map(|value| value.redact_with(mapper))
            .collect()
    }
}

impl<T> RedactableWithMapper for VecDeque<T>
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        self.into_iter()
            .map(|value| value.redact_with(mapper))
            .collect()
    }
}

impl<T, const N: usize> RedactableWithMapper for [T; N]
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        self.map(|value| value.redact_with(mapper))
    }
}

impl<T> RedactableWithMapper for Box<T>
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        Box::new((*self).redact_with(mapper))
    }
}

impl<T> RedactableWithMapper for std::sync::Arc<T>
where
    T: RedactableWithMapper + Clone,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        std::sync::Arc::new((*self).clone().redact_with(mapper))
    }
}

impl<T> RedactableWithMapper for std::rc::Rc<T>
where
    T: RedactableWithMapper + Clone,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        std::rc::Rc::new((*self).clone().redact_with(mapper))
    }
}

impl<T> RedactableWithMapper for Mutex<T>
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        // Keep poison recovery explicit at the lock extraction boundary.
        #[allow(clippy::redundant_closure_for_method_calls)]
        let value = self.into_inner().unwrap_or_else(|err| err.into_inner());
        Mutex::new(value.redact_with(mapper))
    }
}

impl<T> RedactableWithMapper for RwLock<T>
where
    T: RedactableWithMapper,
{
    fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
        // Keep poison recovery explicit at the lock extraction boundary.
        #[allow(clippy::redundant_closure_for_method_calls)]
        let value = self.into_inner().unwrap_or_else(|err| err.into_inner());
        RwLock::new(value.redact_with(mapper))
    }
}

macro_rules! impl_tuple_redactable_with_mapper {
    ($($name:ident),+ $(,)?) => {
        impl<$($name),+> RedactableWithMapper for ($($name,)+)
        where
            $($name: RedactableWithMapper,)+
        {
            #[allow(non_snake_case)]
            fn redact_with<M: RedactableMapper>(self, mapper: &M) -> Self {
                let ($($name,)+) = self;
                ($($name.redact_with(mapper),)+)
            }
        }
    };
}

impl_tuple_redactable_with_mapper!(T0);
impl_tuple_redactable_with_mapper!(T0, T1);
impl_tuple_redactable_with_mapper!(T0, T1, T2);
impl_tuple_redactable_with_mapper!(T0, T1, T2, T3);