Struct CredentialScanner 

pub struct CredentialScanner { /* private fields */ }

Pre-compiled multi-pattern credential scanner.

Construct once with CredentialScanner::new (or CredentialScanner::with_config) and call CredentialScanner::scan repeatedly. Pattern compilation happens at construction time; each scan call is O(n) in the length of the input text.

Implementations

impl CredentialScanner

pub fn new() -> Self

Build the scanner with all built-in patterns and scanning enabled.

Panics

Panics only if the hard-coded AC patterns are somehow invalid — this cannot happen in practice.

pub fn with_config(config: ScannerConfig) -> Self

Build the scanner from explicit configuration.

Custom patterns are appended after the built-in set and are tagged as CredentialKind::Custom. If config.disabled is true the scanner is inert — scan always returns an empty result.

pub fn scan(&self, text: &str) -> ScanResult

Scan text for credential patterns and return a ScanResult.

Four passes are performed:

1. Aho-Corasick literal prefix scan — O(n), 18 patterns covering API keys, auth tokens, cloud credentials, database URLs, and PEM private key headers.
2. Credit card and SSN digit-sequence scan.
3. Email address scan.
4. High-entropy token scan (Shannon entropy > 4.5 bits/char, length 20–64).

Trait Implementations

impl Default for CredentialScanner

fn default() -> Self

Returns the “default value” for a type.