Struct RedactedText 

pub struct RedactedText<'a>(/* private fields */);

A value that has passed through field-sensitive redaction.

This type deliberately does not implement std::fmt::Display. Plain-text log sinks must first call Self::escape_for_log so that controls and bidirectional formatting characters cannot manipulate rendered log output.

use qubit_redact::Redactor;

let value = Redactor::default().redact("message", "hello");
let _ = format!("{value}");

Type Parameters

• 'a - Lifetime of any borrowed redacted text stored by the value.

Implementations

impl<'a> RedactedText<'a>

pub fn as_str(&self) -> &str

Borrows the redacted contents.

Returns

The redacted text as a string slice.

pub fn into_owned(self) -> String

Converts the redacted contents into an owned string.

Returns

The redacted text, allocating only when the value is borrowed.

pub fn escape_for_log(self) -> LogSafeText<'a>

Escapes the redacted contents for a plain-text log boundary.

All control characters, Unicode line and paragraph separators, and Unicode bidirectional formatting controls are rendered with debug escapes. Safe borrowed input remains borrowed.

Returns

Typed text that is safe to render with std::fmt::Display.

Trait Implementations

impl<'a> Clone for RedactedText<'a>

fn clone(&self) -> RedactedText<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RedactedText<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for RedactedText<'a>

impl<'a> PartialEq for RedactedText<'a>

fn eq(&self, other: &RedactedText<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for RedactedText<'a>