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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Fallback behavior for fields without an explicit policy rule.

use super::Sensitivity;

/// Determines how a policy handles a field with no matching rule.
///
/// The default preserves compatibility by leaving unknown fields visible.
#[must_use]
#[non_exhaustive]
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum UnknownFieldPolicy {
    /// Leaves values visible when no explicit rule classifies their field.
    #[default]
    PassThrough,
    /// Applies the supplied sensitivity to every unclassified field.
    Redact(
        /// Sensitivity used as the fallback classification.
        Sensitivity,
    ),
}

impl UnknownFieldPolicy {
    /// Returns the sensitivity selected for an unclassified field.
    ///
    /// # Returns
    ///
    /// Some(level) when unknown fields must be redacted, or None when they
    /// must remain visible.
    #[must_use]
    #[inline(always)]
    pub const fn sensitivity(self) -> Option<Sensitivity> {
        match self {
            Self::PassThrough => None,
            Self::Redact(level) => Some(level),
        }
    }
}