vox-redact API Reference (generated)
Crate: vox-redact · Version: 0.6.0 · Target: Library (lib.rs)
Regex-based redaction of secrets and PII from log lines and JSON values.
Crate Overview
Section titled “Crate Overview”Conservative PII/secret redaction. Moved from vox-terminal-core::corpus::redact
so non-terminal crates (e.g. agent operation capture) can reuse it without a
backwards dependency edge.
Redaction is conservative: unknown patterns are left as-is. Only patterns with high precision (low false-positive rate) are elided.
Public API Surface
Section titled “Public API Surface”Functions
Section titled “Functions”| Function | Description |
|---|---|
redact_owned | Redact PII/secret patterns in free text. Conservative: unknown patterns pass through. |
redact_args | Recursively redact a JSON value: values under secret-ish keys become "[REDACTED]"; all other string scalars are run through [redact_owned]. |
Dependency Topology
Section titled “Dependency Topology”Diagram source
graph { direction: right node vox_redact: "vox-redact" node vox_orchestrator_mcp: "vox-orchestrator-mcp" vox_orchestrator_mcp -> vox_redact node vox_terminal_core: "vox-terminal-core" vox_terminal_core -> vox_redact}Reverse Dependents (Used By)
Section titled “Reverse Dependents (Used By)”| Consumer Crate | Role |
|---|---|
vox-orchestrator-mcp | Direct workspace dependent |
vox-terminal-core | Direct workspace dependent |
Deep Public Symbols (Source-Anchored)
Section titled “Deep Public Symbols (Source-Anchored)”| Kind | Symbol | Signature | Source | Description |
|---|---|---|---|---|
fn | redact_owned | pub fn redact_owned(text: &str) -> String | crates/vox-redact/src/lib.rs#L67-L74 | Redact PII/secret patterns in free text. Conservative: unknown patterns pass through. |
fn | redact_args | pub fn redact_args(value: &serde_json::Value) -> serde_json::Value | crates/vox-redact/src/lib.rs#L100-L118 | Recursively redact a JSON value: values under secret-ish keys become "[REDACTED]"; all other string scalars are run through [redact_owned]. |