Enum MaskPolicy 

pub enum MaskPolicy {
    Fixed {
        replacement: String,
    },
    PreserveEdges {
        prefix_chars: usize,
        suffix_chars: usize,
        replacement: String,
        full_mask_below_or_equal: usize,
    },
    PreserveSuffix {
        suffix_chars: usize,
        replacement: String,
        full_mask_below_or_equal: usize,
    },
    Empty,
}

Strategy used to mask one sensitive field value.

Variants

Fixed

Replaces non-empty values with a fixed replacement string.

Fields

replacement: String

Replacement used for non-empty values.

PreserveEdges

Preserves a prefix and suffix for diagnosability.

Fields

prefix_chars: usize

Number of leading Unicode scalar values to retain.

suffix_chars: usize

Number of trailing Unicode scalar values to retain.

replacement: String

Replacement inserted between retained edges.

full_mask_below_or_equal: usize

Values at or below this character length are fully masked.

PreserveSuffix

Preserves only the final part of the value.

Fields

suffix_chars: usize

Number of trailing Unicode scalar values to retain.

replacement: String

Replacement inserted before the retained suffix.

full_mask_below_or_equal: usize

Values at or below this character length are fully masked.

Empty

Removes non-empty values entirely.

Implementations

impl MaskPolicy

pub fn fixed(replacement: &str) -> Self

Creates a fixed-replacement mask policy.

Parameters

• replacement - Replacement used for non-empty values.

Returns

A mask policy that replaces non-empty values with replacement.

pub fn preserve_edges( prefix_chars: usize, suffix_chars: usize, replacement: &str, full_mask_below_or_equal: usize, ) -> Self

Creates an edge-preserving mask policy.

Parameters

• prefix_chars - Number of leading characters to retain.
• suffix_chars - Number of trailing characters to retain.
• replacement - Replacement inserted between retained edges.
• full_mask_below_or_equal - Character length threshold for full masks.

Returns

A mask policy that keeps selected value edges for long values.

pub fn preserve_suffix( suffix_chars: usize, replacement: &str, full_mask_below_or_equal: usize, ) -> Self

Creates a suffix-preserving mask policy.

Parameters

• suffix_chars - Number of trailing characters to retain.
• replacement - Replacement inserted before the suffix.
• full_mask_below_or_equal - Character length threshold for full masks.

Returns

A mask policy that keeps only the selected trailing characters.

pub const fn empty() -> Self

Creates a policy that removes non-empty values.

Returns

A mask policy that returns an empty value for every non-empty input.

pub fn mask<'a>(&self, value: &'a str) -> Cow<'a, str>

Masks one value according to this policy.

Empty values are preserved as empty because they do not leak sensitive material and keeping them empty preserves field semantics.

Parameters

• value - Field value to mask.

Returns

Borrowed value when it is empty, otherwise an owned masked value.

Trait Implementations

impl Clone for MaskPolicy

fn clone(&self) -> MaskPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaskPolicy

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

Formats the value using the given formatter.

impl PartialEq for MaskPolicy

fn eq(&self, other: &MaskPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MaskPolicy

impl StructuralPartialEq for MaskPolicy