qubit_redact/policy/field/
sensitive_field_rule.rs

1// =============================================================================
2//    Copyright (c) 2025 - 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! Read-only views of configured sensitive-field rules.
9
10use super::Sensitivity;
11
12/// A borrowed canonical field name and its configured sensitivity.
13///
14/// # Type Parameters
15///
16/// * `'a` - Lifetime of the borrowed canonical field name.
17#[derive(Debug, Clone, Copy, PartialEq, Eq)]
18pub struct SensitiveFieldRule<'a> {
19    /// Canonical field name.
20    field: &'a str,
21    /// Configured sensitivity level.
22    sensitivity: Sensitivity,
23}
24
25impl<'a> SensitiveFieldRule<'a> {
26    /// Creates a borrowed sensitive-field rule view.
27    ///
28    /// # Parameters
29    ///
30    /// * `field` - Canonical field name.
31    /// * `sensitivity` - Configured sensitivity level.
32    ///
33    /// # Returns
34    ///
35    /// A read-only view over the supplied rule.
36    #[must_use]
37    #[inline(always)]
38    pub(super) const fn new(field: &'a str, sensitivity: Sensitivity) -> Self {
39        Self { field, sensitivity }
40    }
41
42    /// Returns the canonical field name.
43    ///
44    /// # Returns
45    ///
46    /// The canonical field name borrowed from the policy.
47    #[must_use]
48    #[inline(always)]
49    pub const fn field(&self) -> &'a str {
50        self.field
51    }
52
53    /// Returns the configured sensitivity level.
54    ///
55    /// # Returns
56    ///
57    /// The sensitivity assigned to the field.
58    #[must_use]
59    #[inline(always)]
60    pub const fn sensitivity(&self) -> Sensitivity {
61        self.sensitivity
62    }
63}
qubit_redact/policy/field/sensitive_field_rule.rs

qubit_redact/policy/field/
sensitive_field_rule.rs
