Struct BasicRedactor 

pub struct BasicRedactor { /* private fields */ }

A ready-to-use redactor covering what actually leaks from a production error message: the user’s home directory, anything that looks like a credential, and email addresses.

This exists because “production adopters MUST supply a real one” is advice that does not survive contact with a release deadline — a default that is safe beats a default that is correct only if someone remembers. It is a starting point, not a compliance boundary: a project handling regulated data should compose its own Redactor on top.

What it does:

• Replaces the home directory with ~ and the username elsewhere in a path with ~user, so /home/ada/db/main.db becomes ~/db/main.db — the structure a maintainer needs, without the identity. Matching ignores case and separator spelling, and respects path boundaries.
• Masks the value of a key = value pair whose key names a credential (password, token, authorization, x-api-key, AZURE_OPENAI_KEY, …) in whatever form it arrives: quoted or bare, spaced or tight, or introduced by an HTTP auth scheme, where the credential follows the scheme word. A composite value — Some("…"), Credentials("…", "…"), ["…", "…"], Secret { inner: "…" } — has every leaf inside it masked, its structure kept.
• Masks the same keys inside JSON — including breadcrumb fields and DomainContext payloads, where the key is an object member and a per-string scan would never see it.
• Masks a credential that arrives with no key at all, recognised by issuer prefix (sk-, ghp_, AKIA, …), JWT structure, or PEM block.
• Masks anything shaped like an email address, including keys of a map that is keyed by one.

Where precision and safety conflict it over-redacts: a masked diagnostic field costs a debugging session, a missed credential costs the credential. Key names that are merely credential-adjacent (grouping_key, auth) are the exception — they mask only a value that is itself credential-shaped, so the fields a report is read and fingerprinted by survive.

Implementations

impl BasicRedactor

pub fn new() -> Self

Build a redactor for the current user’s environment.

pub fn home(self, home: impl Into<String>) -> Self

Override the home directory to strip. Mainly for tests and for daemons that run as a service account but report on a user’s data directory.

Trait Implementations

impl Default for BasicRedactor

fn default() -> Self

Returns the “default value” for a type.

impl Redactor for BasicRedactor

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

Return input with any sensitive substrings replaced.

fn redact_value_for_key(&self, key: &str, value: &mut Value)

Redact one object member, given the key it is stored under.

fn redact_key(&self, key: &str) -> String

Redact an object key. Keys are usually field names — structure worth keeping — so the default returns them unchanged. A map keyed by user data is the exception, and the reason this hook exists.

fn redact_json(&self, value: &mut Value)

Redact every string node within a JSON value, structure preserved.