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
91
92
93
94
95
96
97

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Explicit logical in-place redaction contract for domain objects.

use crate::RedactionPolicy;

/// Replaces sensitive field values inside a domain object.
///
/// This trait changes the logical value only. It does not zeroize released
/// allocations or affect aliases, existing copies, or borrowed backing data.
pub trait RedactMut {
    /// Redacts this object in place with an explicit policy.
    ///
    /// # Parameters
    ///
    /// * `policy` - Complete policy snapshot governing every mutation.
    fn redact_in_place_with(&mut self, policy: &RedactionPolicy);

    /// Redacts this object in place with a snapshot of the current default.
    #[inline]
    fn redact_in_place(&mut self) {
        let policy = RedactionPolicy::default();
        self.redact_in_place_with(&policy);
    }

    /// Consumes and redacts this object with an explicit policy.
    ///
    /// # Parameters
    ///
    /// * `policy` - Complete policy snapshot governing every mutation.
    ///
    /// # Returns
    ///
    /// The logically redacted object.
    #[must_use = "use the returned redacted object"]
    #[inline]
    fn into_redacted_with(mut self, policy: &RedactionPolicy) -> Self
    where
        Self: Sized,
    {
        self.redact_in_place_with(policy);
        self
    }

    /// Consumes and redacts this object with the current default snapshot.
    ///
    /// # Returns
    ///
    /// The logically redacted object.
    #[must_use = "use the returned redacted object"]
    #[inline]
    fn into_redacted(self) -> Self
    where
        Self: Sized,
    {
        let policy = RedactionPolicy::default();
        self.into_redacted_with(&policy)
    }

    /// Clones and redacts this object with an explicit policy.
    ///
    /// # Parameters
    ///
    /// * `policy` - Complete policy snapshot governing every mutation.
    ///
    /// # Returns
    ///
    /// A redacted clone while the original remains unchanged.
    #[must_use = "use the returned redacted clone"]
    #[inline]
    fn to_redacted_with(&self, policy: &RedactionPolicy) -> Self
    where
        Self: Clone + Sized,
    {
        self.clone().into_redacted_with(policy)
    }

    /// Clones and redacts this object with the current default snapshot.
    ///
    /// # Returns
    ///
    /// A redacted clone while the original remains unchanged.
    #[must_use = "use the returned redacted clone"]
    #[inline]
    fn to_redacted(&self) -> Self
    where
        Self: Clone + Sized,
    {
        let policy = RedactionPolicy::default();
        self.to_redacted_with(&policy)
    }
}