Enum MaskPolicy 

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

Strategy used to mask one sensitive field value.

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.

#[non_exhaustive]

Fixed

Replaces non-empty values with a fixed replacement string.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

replacement: String

Replacement used for non-empty values.

#[non_exhaustive]

PreserveEdges

Preserves a prefix and suffix for diagnosability.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

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.

#[non_exhaustive]

PreserveSuffix

Preserves only the final part of the value.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

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 policy.

Parameters

• replacement - Text returned for every non-empty value.

Returns

A fixed-replacement mask policy.

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

Creates a policy that retains prefix_chars and suffix_chars scalars.

Values no longer than full_mask_below_or_equal, or too short to keep both requested edges without overlap, are replaced completely.

Parameters

• prefix_chars - Number of leading Unicode scalars to retain.
• suffix_chars - Number of trailing Unicode scalars to retain.
• replacement - Text inserted between retained edges.
• full_mask_below_or_equal - Scalar-count threshold for full masking.

Returns

An edge-preserving mask policy.

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

Creates a policy that retains suffix_chars trailing Unicode scalars.

Values no longer than full_mask_below_or_equal, or no longer than the requested suffix, are replaced completely.

Parameters

• suffix_chars - Number of trailing Unicode scalars to retain.
• replacement - Text inserted before the retained suffix.
• full_mask_below_or_equal - Scalar-count threshold for full masking.

Returns

A suffix-preserving mask policy.

pub const fn empty() -> Self

Creates a policy that removes every non-empty value.

Returns

A mask policy that produces an empty result.

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

Masks value according to this policy.

Empty values remain borrowed and empty. Non-empty values return an owned mask, with edge counts measured in Unicode scalar values.

Type Parameters

• 'a - Lifetime of the input and any borrowed result.

Parameters

• value - Value to mask.

Returns

The borrowed empty input or an owned masked value.

pub fn opaque_mask(&self) -> &str

Returns the complete replacement for a value whose contents are opaque.

Edge-preserving policies cannot safely retain any part of an opaque value, so this method returns only their configured replacement.

Returns

The complete configured replacement, or an empty string for Self::Empty.

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 Eq for MaskPolicy

impl PartialEq for MaskPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MaskPolicy