Enum FieldClassification 

#[non_exhaustive]
pub enum FieldClassification<'a> {
    Sensitive {
        rule: SensitiveFieldRule<'a>,
        match_kind: FieldMatchKind,
    },
    Allowed {
        rule: AllowRule<'a>,
        match_kind: FieldMatchKind,
    },
    Unknown,
}

Explains why a field is sensitive, allowed, or unknown to a policy.

Matched rules borrow canonical field names from the immutable policy, so callers can inspect classification without cloning rule metadata.

Type Parameters

• 'a - Lifetime of canonical field names borrowed from the policy.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sensitive

A sensitive rule classified the field.

Fields

rule: SensitiveFieldRule<'a>

Borrowed configured rule that supplied the sensitivity.

match_kind: FieldMatchKind

The canonical input candidate that matched this rule.

Allowed

An allow rule took precedence over sensitivity at the same candidate.

Fields

rule: AllowRule<'a>

Borrowed configured rule that allowed the field.

match_kind: FieldMatchKind

The canonical input candidate that matched this rule.

Unknown

No configured rule classified the field.

Implementations

impl<'a> FieldClassification<'a>

pub const fn sensitivity(self) -> Option<Sensitivity>

Returns the configured sensitivity when the field is sensitive.

Returns

Some(level) for Self::Sensitive, or None for allowed and unknown fields.

pub const fn matched_field(self) -> Option<&'a str>

Returns the canonical configured field that matched.

Returns

A field name borrowed from the policy for sensitive and allowed classifications, or None for Self::Unknown.

pub const fn match_kind(self) -> Option<FieldMatchKind>

Returns the canonical input candidate that matched the configured rule.

Returns

The exact input or a semantic token suffix for sensitive and allowed classifications, or None for Self::Unknown.

pub const fn is_allowed(self) -> bool

Reports whether an allow rule classified the field.

Returns

true only for Self::Allowed.

pub const fn is_unknown(self) -> bool

Reports whether no configured rule classified the field.

Returns

true only for Self::Unknown.

Trait Implementations

impl<'a> Clone for FieldClassification<'a>

fn clone(&self) -> FieldClassification<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for FieldClassification<'a>

impl<'a> Debug for FieldClassification<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Eq for FieldClassification<'a>

impl<'a> PartialEq for FieldClassification<'a>

fn eq(&self, other: &FieldClassification<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for FieldClassification<'a>