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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Observable result of mutable JSON traversal.

/// Records whether a JSON traversal retained any unkeyed scalar value.
#[must_use]
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub(crate) struct JsonRedactionOutcome {
    /// Whether at least one unkeyed scalar remained visible.
    passed_unkeyed: bool,
}

impl JsonRedactionOutcome {
    /// Returns an outcome for one retained unkeyed scalar.
    ///
    /// # Returns
    ///
    /// An outcome reporting that a scalar passed through.
    #[inline(always)]
    pub(crate) const fn passed_unkeyed() -> Self {
        Self {
            passed_unkeyed: true,
        }
    }

    /// Reports whether any traversed unkeyed scalar remained visible.
    ///
    /// # Returns
    ///
    /// True when at least one unkeyed scalar passed through.
    #[cfg_attr(not(feature = "http"), allow(dead_code))]
    #[inline(always)]
    pub(crate) const fn has_passed_unkeyed(self) -> bool {
        self.passed_unkeyed
    }

    /// Combines this outcome with a nested traversal result.
    ///
    /// # Parameters
    ///
    /// * other - Nested traversal result.
    #[inline(always)]
    pub(crate) fn merge(&mut self, other: Self) {
        self.passed_unkeyed |= other.passed_unkeyed;
    }
}