Skip to main content

RedactedText

Struct RedactedText 

Source
pub struct RedactedText(/* private fields */);
Expand description

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§

Source§

impl RedactedText

Source

pub fn as_str(&self) -> &str

Borrows the final redacted text.

Source

pub fn into_string(self) -> String

Consumes the wrapper and returns its owned text.

Trait Implementations§

Source§

impl AsRef<str> for RedactedText

Source§

fn as_ref(&self) -> &str

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

Source§

impl Clone for RedactedText

Source§

fn clone(&self) -> RedactedText

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RedactedText

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RedactedText

Source§

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

Writes only the finalized safe text to the destination formatter.

Source§

impl Eq for RedactedText

Source§

impl Hash for RedactedText

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RedactedText

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RedactedText

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.