Struct EngineBuilder 

pub struct EngineBuilder { /* private fields */ }

Builds an Engine. Start with Engine::builder.

use veil_engine::{Engine, RulesFile, ScopeId};

let engine = Engine::builder().rules(RulesFile::default()).build()?;
let r = engine.redact_text(&ScopeId::new("chat-42"), "Email ana@example.com")?;
assert_eq!(r.text, "Email [EMAIL_1]");

Implementations

impl EngineBuilder

pub fn rules(self, rules: RulesFile) -> Self

What to detect. Default: RulesFile::default.

pub fn options(self, options: Options) -> Self

The placeholder format and restoration options. Default: Options::default.

pub fn recognizer(self, recognizer: Arc<dyn EntityRecognizer>) -> Self

The name-detection model, used when the rules turn name detection on. Without one, such rules make every redaction fail rather than send names.

pub fn compiled_rules(self, rules: CompiledRules) -> Self

Rules compiled in advance with CompiledRules::compile, used as they are. Replaces anything given to rules, options and recognizer.

pub fn vault(self, vault: Arc<dyn Vault>) -> Self

Where placeholder mappings are kept. Default: a new MemoryVault.

pub fn recorder(self, recorder: Arc<dyn Recorder>) -> Self

Told about every value that live traffic matched. Default: none.

pub fn scan_cache_bytes(self, bytes: usize) -> Self

Memory for remembering scans between calls, in bytes; 0 scans every call in full. Default: DEFAULT_SCAN_CACHE_BUDGET.

pub fn build(self) -> Result<Engine, RulesError>

Compiles the rules, unless they were given compiled, and builds the engine.

Trait Implementations

impl Default for EngineBuilder

fn default() -> Self

Returns the “default value” for a type.