Struct RegexScanner 

pub struct RegexScanner { /* private fields */ }

Redacts matches of caller-supplied patterns, RoundTrip by default.

Implementations

impl RegexScanner

pub const ID: ScannerId

This scanner’s id.

pub fn new(rules: Vec<RegexRule>) -> Self

Build a scanner from compiled rules. Direction defaults to Direction::Input, policy to RestorePolicy::RoundTrip.

pub fn from_patterns<'a>( patterns: impl IntoIterator<Item = (&'a str, &'a str)>, ) -> (Self, Vec<(String, Error)>)

Build a scanner from (pattern, label) pairs, compiling each. Patterns that fail to compile are skipped and returned alongside the scanner so the caller can surface a configuration error rather than silently dropping a rule.

pub fn with_direction(self, direction: Direction) -> Self

Override the direction this scanner runs on (input, output, or — by registering the scanner in both directions — both).

pub fn with_policy(self, policy: RestorePolicy) -> Self

Override the restore policy. RoundTrip tokenizes and a paired RestoreScanner rehydrates on output; OneWay redacts permanently.

pub fn policy(&self) -> RestorePolicy

This scanner’s restore policy.

pub fn labels(&self) -> impl Iterator<Item = &str>

The entity labels this scanner interns under — the set a RestoreScanner must own to rehydrate its RoundTrip redactions.

Trait Implementations

impl Clone for RegexScanner

fn clone(&self) -> RegexScanner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegexScanner

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

Formats the value using the given formatter.

impl Scanner for RegexScanner

fn id(&self) -> ScannerId

Stable identifier (e.g. native:pii).

fn direction(&self) -> Direction

Which path this scanner runs on.

fn disposition(&self) -> Disposition

Whether this scanner may block, or only transforms.

fn scan<'a>(&self, text: &'a str, ctx: &mut ScanCtx) -> ScanResult<'a>

Inspect/transform text. The borrowed Verdict::text lets a pure detector return the input with zero allocation.

fn max_input_inflation_ratio(&self) -> f64

Token-inflation bound for an admission estimate (sentinels grow the request). Default 1.0.

fn hold_back(&self) -> HoldBack

How much trailing text a streaming OUTPUT runner must hold back for this scanner. Default HoldBack::TokenBoundary — most patterns are token-bounded. A full-text scanner overrides to HoldBack::WholeStream.

fn stream_patterns(&self) -> Vec<String>

The regex patterns this scanner redacts (or blocks on) when it runs on the OUTPUT path — the shapes the streaming runner’s hold-back DFA must recognise so a match forming across a chunk boundary is never half- emitted. Default empty: a scanner that never redacts streamed output (a pure restore scanner, an input-only scanner) contributes nothing; the runner still holds back live vault sentinels for restore independently.