Struct RedactionPolicy 

pub struct RedactionPolicy { /* private fields */ }

Implementations

impl RedactionPolicy

pub fn passthrough() -> Self

Permissive policy used by tests that need raw data. No headers, fields, or strings are scrubbed.

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

Add a header (case-insensitive) to the safe-list. Header redaction will leave its value untouched even if the name would otherwise look auth-shaped (e.g. an x-…-key header that is actually a request-id).

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

Add a substring (case-insensitive) that always forces a header to be treated as sensitive. Useful for product-specific token header names that the default cookie/authorization/token/secret/key substring set would miss.

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

Add a JSON field name (case-insensitive, exact match) that should always be redacted regardless of value contents. Useful when a host knows it stores internal_audit_token or similar.

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

Add an extra URL query parameter name to redact.

pub fn disable_string_scan(self) -> Self

Disable the heuristic free-form string scanner. The scanner adds a small but non-zero cost to every JSON payload walk; turn it off for performance-critical paths that have already been audited.

pub fn header_is_sensitive(&self, name: &str) -> bool

Whether a given HTTP header name should have its value replaced with REDACTED_HEADER_VALUE.

Host-explicit deny substrings always win, even over the built-in safe-list — that is how a host says “treat my own webhook delivery header as sensitive even though Harn would normally keep it for debugging.”

pub fn field_is_sensitive(&self, name: &str) -> bool

Whether a JSON object field name should be replaced with the redacted placeholder before the value is even inspected.

pub fn url_param_is_sensitive(&self, name: &str) -> bool

Whether a URL query parameter name should have its value replaced.

pub fn redact_headers( &self, headers: &BTreeMap<String, String>, ) -> BTreeMap<String, String>

Returns a BTreeMap of headers with sensitive values replaced by REDACTED_HEADER_VALUE.

pub fn redact_url(&self, url: &str) -> String

Redact sensitive query parameters and credentials in URL userinfo. Returns the input unchanged if nothing matches or the URL fails to parse.

pub fn redact_string<'a>(&self, value: &'a str) -> Cow<'a, str>

Returns a redacted string. Cheap (Cow::Borrowed) when nothing matched. Applies, in order: URL-shaped string detection (so the userinfo or sensitive query params on https://user:pw@…?api_key=… are scrubbed), then high-confidence secret pattern replacement.

pub fn redact_json_in_place(&self, value: &mut JsonValue)

Recursively walk a JSON value, redacting sensitive object fields and string contents in place.

pub fn redact_json(&self, value: &JsonValue) -> JsonValue

Convenience for callers that have an immutable JSON value: clone once and redact.

Trait Implementations

impl Clone for RedactionPolicy

fn clone(&self) -> RedactionPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RedactionPolicy

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

Formats the value using the given formatter.

impl Default for RedactionPolicy

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RedactionPolicy

fn eq(&self, other: &RedactionPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RedactionPolicy

impl StructuralPartialEq for RedactionPolicy