Struct RedactedText 

pub struct RedactedText(/* private fields */);

Final UTF-8 text produced by a redaction operation under its selected policy.

The value has crossed the runtime’s plain-text presentation boundary. It is owned and can be rendered with std::fmt::Display without running another redaction pass. This guarantee is policy-relative: a disabled policy or an explicitly unredacted writer operation may deliberately preserve source content. Callers must not treat this type as proof that the text is confidential in every policy configuration. Any additional length restriction belongs to the caller’s final logging or presentation sink.

Examples

use qubit_redact::Redactor;

let output = Redactor::strict().redact_field("password", "raw-secret");
assert_eq!(output.text().as_str(), "<redacted>");

Implementations

impl RedactedText

pub fn as_str(&self) -> &str

Borrows the final redacted text.

Returns

The finalized UTF-8 text borrowed from this wrapper.

pub fn into_string(self) -> String

Consumes the wrapper and returns its owned text.

Returns

The owned finalized text without cloning.

Trait Implementations

impl AsRef<str> for RedactedText

fn as_ref(&self) -> &str

Borrows the safe text through the standard string-reference contract.

Returns

The finalized text borrowed under the standard string-reference contract.

impl Clone for RedactedText

fn clone(&self) -> RedactedText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactedText

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

Formats the value using the given formatter.

impl Display for RedactedText

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

Writes only the finalized safe text to the destination formatter.

Parameters

• formatter: Destination receiving the already finalized text.

Returns

Success after writing the text.

Errors

Propagates a destination formatting error.

impl Eq for RedactedText

impl Hash for RedactedText

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RedactedText

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactedText