qubit-redact 0.9.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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Compact sets of redaction degradation reasons.

use super::RedactionReason;

/// Compact set of summary reasons.
///
/// # Examples
///
/// ```
/// use qubit_redact::RedactionReason;
/// use qubit_redact::RedactionReasons;
///
/// let reasons = RedactionReasons::empty().with(RedactionReason::InputLimitReached);
/// assert!(reasons.contains(RedactionReason::InputLimitReached));
/// assert!(!reasons.contains(RedactionReason::OutputLimitReached));
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct RedactionReasons(
    /// Stable bit flags for the reasons accumulated by one operation.
    u64,
);

impl RedactionReasons {
    /// Creates an empty reason set.
    ///
    /// # Returns
    ///
    /// A set containing no degradation reasons.
    #[must_use]
    #[inline(always)]
    pub const fn empty() -> Self {
        Self(0)
    }

    /// Returns whether a reason is present.
    ///
    /// # Parameters
    ///
    /// - `reason`: Degradation reason whose membership is queried.
    ///
    /// # Returns
    ///
    /// True exactly when this set contains the requested reason.
    #[must_use]
    #[inline(always)]
    pub const fn contains(self, reason: RedactionReason) -> bool {
        self.0 & reason.bit() != 0
    }

    /// Adds one reason.
    ///
    /// # Parameters
    ///
    /// - `reason`: Degradation reason to insert.
    ///
    /// # Returns
    ///
    /// A copy of this set containing the supplied reason.
    #[must_use]
    #[inline(always)]
    pub const fn with(self, reason: RedactionReason) -> Self {
        Self(self.0 | reason.bit())
    }

    /// Combines two reason sets.
    ///
    /// # Parameters
    ///
    /// - `other`: Additional degradation reasons to combine.
    ///
    /// # Returns
    ///
    /// A set containing every reason present in either operand.
    #[must_use]
    #[inline(always)]
    pub const fn union(self, other: Self) -> Self {
        Self(self.0 | other.0)
    }
}