Struct SecretRedactor 

pub struct SecretRedactor { /* private fields */ }

Central exact-value and structured-field redactor.

Registered patterns are held in SecretBytes and are therefore neither debug-formatted nor serialized. Register every secret before starting the child process or provider request that may emit it.

Implementations

impl SecretRedactor

pub fn new() -> Self

Create a redactor with no registered values.

pub fn register_secret(&mut self, secret: &Secret) -> Result<(), RedactionError>

Register a UTF-8 secret without taking ownership from its caller.

Errors

Returns RedactionError::EmptySecret for an empty value.

pub fn register_secret_bytes( &mut self, secret: &SecretBytes, ) -> Result<(), RedactionError>

Register arbitrary secret bytes without taking ownership from its caller.

Errors

Returns RedactionError::EmptySecret for an empty value.

pub fn stream(&self) -> StreamingRedactor<'_>

Create an independent chunk-safe stream redactor.

pub fn command_output(&self) -> CommandOutputRedactor<'_>

Create independent stdout and stderr redaction state.

pub fn redact_bytes(&self, input: &[u8]) -> Vec<u8>

Redact registered values from one complete byte buffer.

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

Redact registered values from one complete UTF-8 string.

pub fn redact_arguments(&self, arguments: &[String]) -> Vec<String>

Redact command arguments by exact value and by sensitive option name.

pub fn redact_environment( &self, environment: &BTreeMap<String, String>, ) -> BTreeMap<String, String>

Redact environment values by exact value and by sensitive variable name.

pub fn redact_json_value(&self, value: &mut Value)

Recursively redact known values and structurally sensitive JSON fields.

Secret-reference fields remain visible because they carry opaque, validated identifiers rather than secret material.

Trait Implementations

impl Default for SecretRedactor

fn default() -> Self

Returns the “default value” for a type.