redactable 0.11.0

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

//! Output wrappers that preserve nested borrow conflicts during policy
//! application and formatting.

use std::cell::RefCell;

// Kept in scope for the intra-doc link on `PolicyFormattingOutput`.
use crate::RedactableWithFormatter;
#[allow(unused_imports)]
use crate::redaction::PolicyApplicableRef;

/// Legacy borrow-safe `RefCell` policy output retained for API compatibility.
pub enum PolicyRefCellOutput<T> {
    /// The source was borrowable and contains the original output shape.
    Value(RefCell<T>),
    /// The source was mutably borrowed; no value or error is retained.
    Borrowed,
}

impl<T: RedactableWithFormatter> RedactableWithFormatter for PolicyRefCellOutput<T> {
    fn fmt_redacted(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Value(value) => value.fmt_redacted(f),
            Self::Borrowed => f.write_str("<borrowed>"),
        }
    }
}

impl<T: std::fmt::Debug> std::fmt::Debug for PolicyRefCellOutput<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Value(value) => std::fmt::Debug::fmt(value, f),
            Self::Borrowed => f.write_str("<borrowed>"),
        }
    }
}

/// Formatting-only result of applying a reference policy.
///
/// This keeps borrow-conflict handling out of [`PolicyApplicableRef::Output`],
/// preserving that public associated-type contract for downstream callers.
pub enum PolicyFormattingOutput<T> {
    /// The policy was applied and produced the normal output shape.
    Value(T),
    /// The source was mutably borrowed; no value or error is retained.
    Borrowed,
}

impl<T> PolicyFormattingOutput<T> {
    /// Transforms a successful formatting value while preserving a borrow conflict.
    pub fn map<U>(self, f: impl FnOnce(T) -> U) -> PolicyFormattingOutput<U> {
        match self {
            Self::Value(value) => PolicyFormattingOutput::Value(f(value)),
            Self::Borrowed => PolicyFormattingOutput::Borrowed,
        }
    }
}

impl<T: RedactableWithFormatter> RedactableWithFormatter for PolicyFormattingOutput<T> {
    fn fmt_redacted(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Value(value) => value.fmt_redacted(f),
            Self::Borrowed => f.write_str("<borrowed>"),
        }
    }
}

impl<T: std::fmt::Debug> std::fmt::Debug for PolicyFormattingOutput<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Value(value) => std::fmt::Debug::fmt(value, f),
            Self::Borrowed => f.write_str("<borrowed>"),
        }
    }
}