Struct Redactor 

pub struct Redactor { /* private fields */ }

A fused-alternation redactor: one regex, one pass, N patterns.

See the crate-level docs for the performance model.

Implementations

impl Redactor

pub fn empty() -> Self

Construct a redactor with no patterns and the default marker. Add patterns via Self::with_pattern.

pub fn with_defaults() -> Self

Construct a redactor pre-loaded with every built-in pattern: credit card, JWT, OAuth bearer, email, IPv4, AWS key.

All six patterns are fused into a single alternation regex at process start-up (via LazyLock). Subsequent calls to this constructor clone the cached Regex — construction is O(1) past the first call.

pub fn with_pattern(self, pattern: &str) -> Result<Self, Error>

Append a custom regex pattern.

The pattern is validated in isolation before being fused into the combined alternation, so a compile error surfaces the specific bad pattern rather than the fused string.

Errors

Returns regex::Error if the pattern fails to compile.

pub fn marker(self, marker: impl Into<String>) -> Self

Override the replacement marker (default: "[REDACTED]").

pub fn scrub(&self, log: Log) -> Log

Scrub a record in-place. Returns the (possibly modified) record for fluent chaining.

pub fn apply(&self, input: &str) -> String

Apply the fused pattern to a single string.

One replace_all pass through the regex DFA replaces every match — regardless of which pattern each match originates from — with the configured marker.

pub fn len(&self) -> usize

How many patterns are loaded.

pub fn is_empty(&self) -> bool

Returns true if no patterns are loaded.

Trait Implementations

impl Clone for Redactor

fn clone(&self) -> Redactor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redactor

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

Formats the value using the given formatter.

impl Default for Redactor

fn default() -> Self

Returns the “default value” for a type.