qubit-redact 0.3.0

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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Value-level logical in-place masking for textual forms.

use std::borrow::Cow;

use crate::{
    MaskingPolicy,
    Sensitivity,
};

/// Replaces a textual value according to one sensitivity level.
///
/// This trait changes the logical value only. It does not zeroize released
/// allocations or affect aliases, existing copies, or borrowed backing data.
pub trait RedactValueMut {
    /// Masks this value in place.
    ///
    /// # Parameters
    ///
    /// * `level` - Sensitivity selecting a mask.
    /// * `masking` - Complete masking configuration.
    fn redact_value_in_place(
        &mut self,
        level: Sensitivity,
        masking: &MaskingPolicy,
    );
}

impl RedactValueMut for String {
    /// Replaces this owned string with the selected mask.
    ///
    /// # Parameters
    ///
    /// * `level` - Sensitivity selecting the mask.
    /// * `masking` - Complete masking configuration.
    #[inline]
    fn redact_value_in_place(
        &mut self,
        level: Sensitivity,
        masking: &MaskingPolicy,
    ) {
        if let Cow::Owned(redacted) = masking.mask(level, self) {
            *self = redacted;
        }
    }
}

impl RedactValueMut for Cow<'_, str> {
    /// Replaces this borrowed-or-owned string with an owned selected mask.
    ///
    /// # Parameters
    ///
    /// * `level` - Sensitivity selecting the mask.
    /// * `masking` - Complete masking configuration.
    #[inline]
    fn redact_value_in_place(
        &mut self,
        level: Sensitivity,
        masking: &MaskingPolicy,
    ) {
        if let Cow::Owned(redacted) = masking.mask(level, self.as_ref()) {
            *self = Cow::Owned(redacted);
        }
    }
}

impl<T: RedactValueMut> RedactValueMut for Option<T> {
    /// Redacts a present value while preserving the option shape.
    ///
    /// # Parameters
    ///
    /// * `level` - Sensitivity selecting the mask.
    /// * `masking` - Complete masking configuration.
    #[inline]
    fn redact_value_in_place(
        &mut self,
        level: Sensitivity,
        masking: &MaskingPolicy,
    ) {
        if let Some(value) = self {
            value.redact_value_in_place(level, masking);
        }
    }
}