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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Read-only views of configured sensitive-field rules.

use super::Sensitivity;

/// A borrowed canonical field name and its configured sensitivity.
///
/// # Type Parameters
///
/// * `'a` - Lifetime of the borrowed canonical field name.
#[must_use]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SensitiveFieldRule<'a> {
    /// Canonical field name.
    field: &'a str,
    /// Configured sensitivity level.
    sensitivity: Sensitivity,
}

impl<'a> SensitiveFieldRule<'a> {
    /// Creates a borrowed sensitive-field rule view.
    ///
    /// # Parameters
    ///
    /// * `field` - Canonical field name.
    /// * `sensitivity` - Configured sensitivity level.
    ///
    /// # Returns
    ///
    /// A read-only view over the supplied rule.
    #[inline]
    pub(super) const fn new(field: &'a str, sensitivity: Sensitivity) -> Self {
        Self { field, sensitivity }
    }

    /// Returns the canonical field name.
    ///
    /// # Returns
    ///
    /// The canonical field name borrowed from the policy.
    #[must_use]
    #[inline]
    pub const fn field(&self) -> &'a str {
        self.field
    }

    /// Returns the configured sensitivity level.
    ///
    /// # Returns
    ///
    /// The sensitivity assigned to the field.
    #[inline]
    pub const fn sensitivity(&self) -> Sensitivity {
        self.sensitivity
    }
}