veil-engine 0.2.0

Detection, placeholders and restoration. No I/O.
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

//! Errors from redacting and scanning.

use std::error::Error as StdError;
use std::fmt;

/// Why a redaction or scan failed. Callers should not send the text on: a
/// failed redaction means sensitive values may still be in it.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// The rules turn name detection on, but no [`EntityRecognizer`](crate::EntityRecognizer)
    /// was given. The engine fails rather than send names unredacted.
    #[error("name detection is on, but no name-detection model was given")]
    RecognizerMissing,
    /// The name-detection model failed.
    #[error("name detection failed: {0}")]
    Recognizer(#[from] RecognizerError),
    /// The [`Vault`](crate::Vault) failed.
    #[error("vault: {0}")]
    Vault(#[from] VaultError),
}

/// Defines an error type that wraps an implementation's own error, so the
/// engine's API doesn't depend on any one implementation.
macro_rules! wrapped_error {
    ($(#[$doc:meta])* $name:ident) => {
        $(#[$doc])*
        #[derive(Debug)]
        pub struct $name(Box<dyn StdError + Send + Sync>);

        impl $name {
            /// Wraps an error, or a message such as `"disk full"`.
            pub fn new(error: impl Into<Box<dyn StdError + Send + Sync>>) -> Self {
                $name(error.into())
            }

            /// The wrapped error, for example to downcast it.
            pub fn get_ref(&self) -> &(dyn StdError + Send + Sync + 'static) {
                &*self.0
            }

            /// Returns the wrapped error.
            pub fn into_inner(self) -> Box<dyn StdError + Send + Sync> {
                self.0
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                self.0.fmt(f)
            }
        }

        impl StdError for $name {
            fn source(&self) -> Option<&(dyn StdError + 'static)> {
                self.0.source()
            }
        }
    };
}

wrapped_error! {
    /// An error from a [`Vault`](crate::Vault) implementation.
    VaultError
}

wrapped_error! {
    /// An error from an [`EntityRecognizer`](crate::EntityRecognizer) implementation.
    RecognizerError
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn wrapped_errors_show_the_inner_message() {
        let io = std::io::Error::other("disk full");
        let e = Error::from(VaultError::new(io));
        assert_eq!(e.to_string(), "vault: disk full");
        let Error::Vault(v) = e else { unreachable!() };
        assert!(v.get_ref().downcast_ref::<std::io::Error>().is_some());
        assert_eq!(
            Error::from(RecognizerError::new("model crashed")).to_string(),
            "name detection failed: model crashed"
        );
    }
}