Enum MaskStrategy 

pub enum MaskStrategy {
    Redact,
    PartialMask {
        reveal_prefix: usize,
        reveal_suffix: usize,
        mask_char: char,
    },
    Hash {
        salt: Option<String>,
    },
    Replace,
    Encrypt {
        key: String,
    },
    Custom(String),
}

How detected PII should be masked.

Examples

use cloakrs_core::MaskStrategy;

let strategy = MaskStrategy::PartialMask {
    reveal_prefix: 1,
    reveal_suffix: 4,
    mask_char: '*',
};
assert!(matches!(strategy, MaskStrategy::PartialMask { .. }));

Variants

Redact

Replace with a typed placeholder such as [EMAIL] or [SSN].

PartialMask

Preserve selected prefix and suffix characters while masking the middle.

Fields

reveal_prefix: usize

Number of characters to reveal at the start.

reveal_suffix: usize

Number of characters to reveal at the end.

mask_char: char

Character used for masked positions.

Hash

Deterministic SHA-256 hash.

Fields

salt: Option<String>

Optional salt.

Replace

Replace with deterministic fake-but-safe data.

Encrypt

AES-256-GCM encryption.

Fields

key: String

Encryption key.

Custom(String)

Replace every finding with this exact string.

Implementations

impl MaskStrategy

pub fn replacement(&self, finding: &PiiEntity) -> String

Returns the replacement text for a finding.

pub fn try_replacement(&self, finding: &PiiEntity) -> Result<String>

Returns the replacement text for a finding, propagating fallible strategies.

Trait Implementations

impl Clone for MaskStrategy

fn clone(&self) -> MaskStrategy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaskStrategy

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

Formats the value using the given formatter.

impl Default for MaskStrategy

fn default() -> MaskStrategy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MaskStrategy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MaskStrategy

fn eq(&self, other: &MaskStrategy) -> 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 Serialize for MaskStrategy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MaskStrategy

impl StructuralPartialEq for MaskStrategy