qubit-redact 0.8.1

Rule-driven redaction for fields, diagnostics, HTTP data, and Rust domain objects
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
161
162
163
164

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Mutable construction of the four-level immutable mask table.

use super::MaskPolicy;
use super::MaskingPolicy;
use crate::Sensitivity;

/// Mutable construction state for a [`MaskingPolicy`].
///
/// # Examples
///
/// ```
/// use qubit_redact::MaskPolicy;
/// use qubit_redact::MaskingPolicy;
/// use qubit_redact::Sensitivity;
///
/// let mut builder = MaskingPolicy::builder();
/// builder.secret(MaskPolicy::fixed("[hidden]"));
/// assert_eq!(builder.build().mask(Sensitivity::Secret, "raw"), "[hidden]");
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MaskingPolicyBuilder {
    /// Draft mask for low-sensitivity values.
    low: MaskPolicy,
    /// Draft mask for medium-sensitivity values.
    medium: MaskPolicy,
    /// Draft mask for high-sensitivity values.
    high: MaskPolicy,
    /// Draft mask for secret values.
    secret: MaskPolicy,
}

impl MaskingPolicyBuilder {
    /// Copies every mask from an immutable table into independent draft state.
    ///
    /// # Parameters
    ///
    /// - `policy`: Immutable mask table to copy.
    ///
    /// # Returns
    ///
    /// A builder retaining all four mask choices.
    #[must_use]
    #[inline(always)]
    pub(super) fn from_policy(policy: &MaskingPolicy) -> Self {
        Self {
            low: policy.for_level(Sensitivity::Low).clone(),
            medium: policy.for_level(Sensitivity::Medium).clone(),
            high: policy.for_level(Sensitivity::High).clone(),
            secret: policy.for_level(Sensitivity::Secret).clone(),
        }
    }

    /// Sets the policy for low-sensitivity values.
    ///
    /// # Parameters
    ///
    /// - `policy`: Replacement masking rule for low sensitivity.
    ///
    /// # Returns
    ///
    /// This builder with the selected level replaced.
    #[inline(always)]
    pub fn low(&mut self, policy: MaskPolicy) -> &mut Self {
        self.low = policy;
        self
    }

    /// Sets the policy for medium-sensitivity values.
    ///
    /// # Parameters
    ///
    /// - `policy`: Replacement masking rule for medium sensitivity.
    ///
    /// # Returns
    ///
    /// This builder with the selected level replaced.
    #[inline(always)]
    pub fn medium(&mut self, policy: MaskPolicy) -> &mut Self {
        self.medium = policy;
        self
    }

    /// Sets the policy for high-sensitivity values.
    ///
    /// # Parameters
    ///
    /// - `policy`: Replacement masking rule for high sensitivity.
    ///
    /// # Returns
    ///
    /// This builder with the selected level replaced.
    #[inline(always)]
    pub fn high(&mut self, policy: MaskPolicy) -> &mut Self {
        self.high = policy;
        self
    }

    /// Sets the policy for secret values.
    ///
    /// # Parameters
    ///
    /// - `policy`: Replacement masking rule for secret sensitivity.
    ///
    /// # Returns
    ///
    /// This builder with the selected level replaced.
    #[inline(always)]
    pub fn secret(&mut self, policy: MaskPolicy) -> &mut Self {
        self.secret = policy;
        self
    }

    /// Builds the immutable masking configuration.
    ///
    /// # Returns
    ///
    /// The immutable mask table. The enclosing redaction policy builder checks
    /// that fixed replacements are nonempty before accepting the table.
    #[must_use]
    #[inline(always)]
    pub fn build(self) -> MaskingPolicy {
        MaskingPolicy::from_parts(self.low, self.medium, self.high, self.secret)
    }

    /// Replaces one sensitivity policy while rebuilding an existing policy.
    ///
    /// # Parameters
    ///
    /// - `level`: Sensitivity whose draft mask is replaced.
    /// - `policy`: Replacement mask for that level.
    #[inline]
    pub(crate) fn policy(&mut self, level: Sensitivity, policy: MaskPolicy) {
        match level {
            Sensitivity::Low => self.low(policy),
            Sensitivity::Medium => self.medium(policy),
            Sensitivity::High => self.high(policy),
            Sensitivity::Secret => self.secret(policy),
        };
    }
}

impl Default for MaskingPolicyBuilder {
    /// Creates a builder with the standard masking policies.
    ///
    /// # Returns
    ///
    /// A builder using the standard low, medium, high, and secret masks.
    #[inline(always)]
    fn default() -> Self {
        Self {
            low: MaskPolicy::preserve_edges(2, 2, "****", 4),
            medium: MaskPolicy::preserve_suffix(1, "*******", 1),
            high: MaskPolicy::fixed("****"),
            secret: MaskPolicy::fixed("<redacted>"),
        }
    }
}