Struct Redacted 

pub struct Redacted<T, R = Simple>
where
    R: Redactor,
{ /* private fields */ }

Struct used to wrap sensitive content that should not be printed/logged. The redaction behaviour is defined by Redactor.

let secret: Redacted<String> = "my_secret_string".to_string().into();

assert_eq!(secret.to_string(), "<redacted>");

let secret: Redacted<String, Custom> = "my_secret_string".to_string().into();

assert_eq!(secret.to_string(), "●●●●●●●●");

Implementations

impl<T, R> Redacted<T, R>

where R: Redactor,

pub fn into_inner(self) -> T

Consumes the Redacted, returning the wrapped value.

 let x: Redacted<_> = "something".into();
 assert_eq!(x.into_inner(), "something");

pub fn inner(&self) -> &T

Get a reference to the wrapped type.

 let x: Redacted<_> = "something".into();
 assert_eq!(*x.inner(), "something");

pub fn inner_mut(&mut self) -> &mut T

Get a mutable reference to the wrapped type.

 let mut x: Redacted<_> = "something".into();
 *x.inner_mut() = "different";

 assert_eq!(*x.inner(), "different");

Trait Implementations

impl<T, R> Clone for Redacted<T, R>

where T: Clone, R: Redactor,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, R> Debug for Redacted<T, R>

where R: Redactor,

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

Formats the value using the given formatter.

impl<T, R> Default for Redacted<T, R>

where T: Default, R: Redactor,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T, R> Deserialize<'de> for Redacted<T, R>

where T: Deserialize<'de>, R: Redactor,

Requires feature serde.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, R> Display for Redacted<T, R>

where R: Redactor,

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

Formats the value using the given formatter.

impl<T, R> From<T> for Redacted<T, R>

where R: Redactor,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T, R> Ord for Redacted<T, R>

where T: Ord, R: Redactor,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T, R> PartialEq<T> for Redacted<T, R>

where T: PartialEq, R: Redactor,

fn eq(&self, other: &T) -> 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<T, R> PartialEq for Redacted<T, R>

where T: PartialEq, R: Redactor,

fn eq(&self, other: &Self) -> 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<T, R> PartialOrd<T> for Redacted<T, R>

where T: PartialOrd, R: Redactor,

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, R> PartialOrd for Redacted<T, R>

where T: PartialOrd, R: Redactor,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, R> Serialize for Redacted<T, R>

where T: Serialize, R: Redactor,

Requires feature serde.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, R> TryZeroize for Redacted<T, R>

where T: TryZeroize, R: Redactor,

fn try_zeroize(&mut self) -> bool

Try to zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<T, R> Zeroize for Redacted<T, R>

where T: Zeroize, R: Redactor,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<T, R> Copy for Redacted<T, R>

where T: Copy, R: Redactor,

impl<T, R> Eq for Redacted<T, R>

where T: Eq, R: Redactor,

impl<T, R> ZeroizeOnDrop for Redacted<T, R>

where T: ZeroizeOnDrop, R: Redactor,