Struct Engine 

pub struct Engine { /* private fields */ }

Finds sensitive values, replaces them with placeholders and puts the real values back. Build one with Engine::builder.

Implementations

impl Engine

pub fn builder() -> EngineBuilder

Starts building an engine. With nothing set, it uses the default rules, the [{TYPE}_{N}] placeholder format and an in-memory vault.

pub fn cache_stats(&self) -> ScanCacheStats

How the cache of recent scans is doing.

pub fn set_rules(&self, rules: CompiledRules)

Swaps in new rules. Calls already running finish with the old ones. Scans made with the old rules are dropped: they can’t be reused.

pub fn rules(&self) -> Arc<CompiledRules>

The rules in use now.

pub fn vault(&self) -> &Arc<dyn Vault>

The vault placeholders are kept in.

pub fn scan(&self, text: &str) -> Result<Vec<Match>, Error>

Finds sensitive values without changing anything or touching the vault.

pub fn redact_text( &self, scope: &ScopeId, text: &str, ) -> Result<Redacted, Error>

Replaces every detected value in text with its placeholder.

pub fn redact_json( &self, scope: &ScopeId, body: &mut Value, policy: &dyn KeyPolicy, ) -> Result<Report, Error>

Redacts every string in body that policy does not skip.

pub fn scan_json( &self, body: &Value, policy: &dyn KeyPolicy, ) -> Result<Report, Error>

Counts what would be redacted in body without changing it (audit mode). Each match is reported to the recorder as sent unchanged.

pub fn restore_text(&self, scope: &ScopeId, text: &str) -> Restored

Replaces every known placeholder in text with its real value. Unknown placeholders are left as they are and counted.

pub fn restore_with( &self, scope: &ScopeId, text: &str, escape: impl Fn(&str) -> String, ) -> Restored

Like Engine::restore_text, but passes each real value through escape first, e.g. to restore inside raw JSON text.

pub fn restore_json( &self, scope: &ScopeId, value: &mut Value, policy: &dyn KeyPolicy, ) -> Report

Restores every string in value that policy does not skip.

Trait Implementations

impl Default for Engine

fn default() -> Self

The default rules and placeholder format, with an in-memory vault.