Struct Scrubber 

pub struct Scrubber { /* private fields */ }

Implementations

impl Scrubber

pub fn empty() -> Self

pub fn with_builtins() -> Result<Self>

Built-in regex patterns only; no entropy, no path rules.

pub fn from_config(config: &ScrubConfig) -> Result<Self>

Build a scrubber from a parsed ScrubConfig.

pub fn with_workspace(workspace_root: &Path) -> Result<Self>

Load .cargo-context/scrub.yaml from workspace_root if present and return a fully-configured scrubber. Falls back to built-ins on absence or parse failure.

pub fn extend(&mut self, extra: Vec<Pattern>) -> Result<()>

Extend the scrubber with extra user-defined patterns (e.g. loaded from a non-default config path).

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

Redact secrets in input. Returns only the scrubbed string.

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

Redact and also produce a ScrubReport listing every redaction.

pub fn scrub_file(&self, path: &Path, content: &str) -> (String, ScrubReport)

Scrub a file’s content, honoring path-based rules (whole-file redaction for redact_whole matches; bypass for exclude matches).

pub fn is_path_redacted(&self, path: &Path) -> bool

Return true if this scrubber’s path rules would redact path whole.

pub fn is_path_excluded(&self, path: &Path) -> bool

Return true if path is on the exclude list (bypasses all scrubbing).

pub fn report_config(&self) -> &ReportConfig

Report config (typically loaded from .cargo-context/scrub.yaml).

pub fn effective_builtin_count(&self) -> usize

Number of built-in patterns that survived disable_builtins and BuiltinsMode::Replace filters. Used by cargo context scrub --check.

pub fn effective_custom_count(&self) -> usize

Number of user-defined patterns[] entries from the config.

pub fn log_redactions(&self, report: &ScrubReport) -> Result<()>

Append each redaction to report.log_file as JSON Lines, if configured. Values are never written — only rule_id, category, severity, and the SHA-256 fingerprint (hash4). Timestamps are Unix epoch seconds.

When report.max_entries is set, the log is truncated after writes to retain only the most recent N entries.

Trait Implementations

impl Debug for Scrubber

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

Formats the value using the given formatter.

impl Default for Scrubber

fn default() -> Scrubber

Returns the “default value” for a type.