Struct SecretSentinel

pub struct SecretSentinel { /* private fields */ }

The main entry point for secret detection and redaction.

• WHAT – Holds a collection of RedactionRules.
• HOW – Provides methods to scrub a string (scrub_text) and to simply check whether any secret is present (contains_secrets).
• WHY – Centralising the rules in a struct enables reuse and makes testing straightforward.

Implementations

impl SecretSentinel

pub fn new_default() -> Self

Constructs a SecretSentinel pre‑populated with a sensible default set of rules.

• WHAT – Returns a sentinel containing three rules: OpenAI, AWS and a generic secret matcher.
• HOW – Instantiates RedactionRules using the lazily‑initialised regexes above and stores them in the rules vector.
• WHY – Provides a ready‑to‑use configuration for typical development environments while still allowing callers to create custom instances.

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

Redacts all secrets found in input according to the configured rules.

• WHAT – Returns a new String where each match has been replaced.
• HOW – Iterates over the rules and applies replace_all for each.
• WHY – Performing the replacements sequentially ensures that overlapping patterns are handled deterministically.

pub fn contains_secrets(&self, input: &str) -> bool

Checks whether any of the configured rules match input.

• WHAT – Returns true if at least one rule’s pattern matches.
• HOW – Uses Iter::any over self.rules with is_match.
• WHY – A quick predicate useful for short‑circuiting logging or error handling before performing the full redaction.