data_privacy 0.11.0

Data annotation and redaction system providing a robust way to manipulate sensitive information.
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

use crate::redaction_engine_inner::RedactionEngineInner;
use crate::{IntoDataClass, RedactionEngine, Redactor};

/// A builder for creating a [`RedactionEngine`].
#[derive(Debug)]
pub struct RedactionEngineBuilder {
    inner: RedactionEngineInner,
}

impl RedactionEngineBuilder {
    /// Creates a new instance of `RedactionEngineBuilder`.
    ///
    /// This is initialized with no registered redactors and a fallback redactor that erases the input.
    #[must_use]
    pub(crate) fn new() -> Self {
        Self {
            inner: RedactionEngineInner::default(),
        }
    }

    /// Adds a redactor for a specific data class.
    ///
    /// Whenever the redaction engine encounters data of this class, it will use the provided redactor.
    ///
    /// If the same data class was previously suppressed or assigned a different redactor,
    /// this call overrides that configuration (last call wins).
    #[must_use]
    pub fn add_class_redactor(mut self, data_class: impl IntoDataClass, redactor: impl Redactor + Send + Sync + 'static) -> Self {
        self.inner.insert(data_class, redactor);
        self
    }

    /// Adds a redactor that's a fallback for when there is no redactor registered for a particular
    /// data class.
    ///
    /// By default, the fallback uses a [`SimpleRedactor`](crate::simple_redactor::SimpleRedactor) configured with
    /// [`SimpleRedactorMode::Erase`](crate::simple_redactor::SimpleRedactorMode::Erase), which simply erases the original string.
    #[must_use]
    pub fn set_fallback_redactor(mut self, redactor: impl Redactor + Send + Sync + 'static) -> Self {
        self.inner.set_fallback(redactor);
        self
    }

    /// Suppresses redaction for a specific data class.
    ///
    /// Data of this class will pass through unmodified, bypassing both class-specific and fallback redactors.
    ///
    /// If the same data class was previously assigned a redactor, this call overrides
    /// that configuration (last call wins).
    #[must_use]
    pub fn suppress_redaction(mut self, data_class: impl IntoDataClass) -> Self {
        self.inner.suppress(data_class);
        self
    }

    /// Builds the `RedactionEngine`.
    #[must_use]
    pub fn build(self) -> RedactionEngine {
        RedactionEngine::new(self.inner)
    }
}