Enum FieldRedaction 

pub enum FieldRedaction<'a> {
    Masked {
        value: RedactedText<'a>,
        sensitivity: Sensitivity,
    },
    PassedThrough {
        value: &'a str,
        reason: PassThroughReason,
    },
}

Explains whether a field value was masked or intentionally passed through.

std::fmt::Debug remains available for inspecting the policy result during debugging. Plain-text log sinks should consume Self::escape_for_log instead of formatting this enum directly.

Variants

Masked

The policy masked the value at the reported sensitivity.

Fields

value: RedactedText<'a>

The typed masked value.

sensitivity: Sensitivity

Sensitivity used to select the mask.

PassedThrough

The policy intentionally retained the original value.

Fields

value: &'a str

The original value borrowed from the caller.

reason: PassThroughReason

Why the policy retained the value.

Implementations

impl<'a> FieldRedaction<'a>

pub fn as_str(&self) -> &str

Returns the processed value as a string slice.

pub const fn is_masked(&self) -> bool

Returns true when the value was masked.

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

Returns the masking sensitivity, or None for pass-through values.

pub const fn pass_through_reason(&self) -> Option<PassThroughReason>

Returns the pass-through reason, or None for masked values.

pub fn into_owned(self) -> String

Converts the processed value into an owned string.

pub fn escape_for_log(self) -> LogSafeText<'a>

Escapes the processed value for a plain-text log boundary.

Trait Implementations

impl<'a> Clone for FieldRedaction<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FieldRedaction<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for FieldRedaction<'a>

impl<'a> PartialEq for FieldRedaction<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for FieldRedaction<'a>