Enum TextRedactionPolicy 

pub enum TextRedactionPolicy {
    Full {
        placeholder: Cow<'static, str>,
    },
    Keep(KeepConfig),
    Mask(MaskConfig),
}

A redaction strategy for string-like values.

All strategies operate on Unicode scalar values and return an owned String.

Variants

Full

Replace the entire value with a fixed placeholder.

Fields

placeholder: Cow<'static, str>

The placeholder text to use.

Keep(KeepConfig)

Keep configured segments visible while masking everything else.

Mask(MaskConfig)

Mask configured segments while leaving the remainder untouched.

Implementations

impl TextRedactionPolicy

pub fn default_full() -> Self

Constructs TextRedactionPolicy::Full using REDACTED_PLACEHOLDER.

pub fn full_with<P>(placeholder: P) -> Self

where P: Into<Cow<'static, str>>,

Constructs TextRedactionPolicy::Full using a custom placeholder.

pub fn keep_with(config: KeepConfig) -> Self

Constructs TextRedactionPolicy::Keep from an explicit configuration.

pub fn keep_first(visible_prefix: usize) -> Self

Keeps only the first visible_prefix scalar values in clear text.

pub fn keep_last(visible_suffix: usize) -> Self

Keeps only the last visible_suffix scalar values in clear text.

pub fn mask_with(config: MaskConfig) -> Self

Masks segments using the provided configuration.

pub fn mask_first(mask_prefix: usize) -> Self

Masks the first mask_prefix scalar values.

pub fn mask_last(mask_suffix: usize) -> Self

Masks the last mask_suffix scalar values.

pub fn with_mask_char(self, mask_char: char) -> Self

Overrides the masking character used by keep/mask policies.

This method has no effect on TextRedactionPolicy::Full because full redaction replaces the entire value with a placeholder string rather than masking individual characters.

pub fn apply_to(&self, value: &str) -> String

Applies the policy to value.

This method is total (it does not return errors).

Trait Implementations

impl Clone for TextRedactionPolicy

fn clone(&self) -> TextRedactionPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextRedactionPolicy

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

Formats the value using the given formatter.

impl Default for TextRedactionPolicy

fn default() -> Self

Returns the “default value” for a type.