Struct RedactionOptions 

pub struct RedactionOptions {
    pub kinds: Vec<PiiKind>,
    pub replacement: Replacement,
    pub custom_patterns: Vec<CustomPattern>,
    pub deny_terms: Vec<String>,
    pub allow_terms: Vec<String>,
    pub ner_min_score: f32,
    pub images: ImageRedaction,
    pub return_mapping: bool,
}

The pass’s settings. Default = every kind, labels, no custom patterns, images dropped, no mapping.

Fields

kinds: Vec<PiiKind>

Which kinds to redact; empty = every kind the available detectors find (the pattern kinds, and the NER kinds when a model runs).

replacement: Replacement

custom_patterns: Vec<CustomPattern>

Extra patterns, redacted as PiiKind::Custom under their own label.

deny_terms: Vec<String>

Literal terms (case-insensitive, whole words) always redacted, as [REDACTED] — a project code name, a client’s name the NER misses.

allow_terms: Vec<String>

Literal terms (case-insensitive) never redacted even when a detector flags them — support@example.com, the company’s own name.

ner_min_score: f32

The NER detector’s minimum confidence for a span (0–1; 0.85 by default — a lone common word in a table header reads as a location at ~0.8, a real name at 0.99+).

images: ImageRedaction

return_mapping: bool

Keep the original → placeholder pairs in the report. Off by default — the report then carries counts only and can be logged or returned over HTTP without leaking what was removed.

Implementations

impl RedactionOptions

pub fn wants(&self, kind: PiiKind) -> bool

Whether kind is in scope (an empty kinds means all).

pub fn wants_ner(&self) -> bool

Whether any NER-only kind is in scope.

Trait Implementations

impl Clone for RedactionOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactionOptions

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

Formats the value using the given formatter.

impl Default for RedactionOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RedactionOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionOptions