Struct LogRedactor 

pub struct LogRedactor { /* private fields */ }

Log redactor that replaces secret values with placeholders

Uses a sliding window buffer to handle secrets that span chunk boundaries.

Streaming Usage

When processing streaming input via redact, the redactor buffers content to detect secrets that span chunk boundaries. Callers must call flush when the stream ends to retrieve any remaining buffered content.

let (mut redactor, _) = LogRedactor::new(secrets);
for chunk in stream {
    let redacted = redactor.redact(&chunk);
    output.push_str(&redacted);
}
// IMPORTANT: Don't forget to flush!
output.push_str(&redactor.flush());

For complete strings where buffering isn’t needed, use redact_immediate instead.

Implementations

impl LogRedactor

pub fn new(secrets: Vec<String>) -> (Self, Vec<ShortSecretWarning>)

Create a new log redactor with the given secret values

Arguments

• secrets - Secret values to redact

Returns

Tuple of (redactor, warnings for short secrets)

pub fn with_names( secrets: impl IntoIterator<Item = (String, String)>, ) -> (Self, Vec<ShortSecretWarning>)

Create a redactor with named secrets for better warnings

Arguments

• secrets - Map of secret names to values

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

Redact secrets from the input string

This method handles streaming input by buffering to catch secrets that span chunk boundaries.

Arguments

• input - Input chunk to process

Returns

Redacted output (may be shorter than input due to buffering)

pub fn flush(&mut self) -> String

Flush any remaining buffered content

Call this when the stream ends to get any remaining output.

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

Redact secrets immediately without buffering

Use this for complete strings where buffering isn’t needed.

pub fn has_secrets(&self) -> bool

Check if any secrets are configured

pub fn secret_count(&self) -> usize

Get the number of secrets being redacted

Trait Implementations

impl Debug for LogRedactor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.