Struct Secret

pub struct Secret<T>(/* private fields */)
where
    T: Zeroize;

Wrapper type for secret values such as passwords or authentication keys.

Once wrapped, the inner value cannot leak accidentally, as both the std::fmt::Display and Debug implementations cover up the actual value and only show the type.

If you need access to the inner value, there is an expose method.

To make sure nothing leaks after the Secret has been dropped, a custom Drop implementation will zero-out the underlying memory.

Implementations

impl<T> Secret<T>

where T: Zeroize,

pub fn new(secret: T) -> Secret<T>

pub fn expose(&self) -> &T

Expose the underlying value of the secret

pub fn redacted(&self) -> &str

Display a placeholder for the secret

Trait Implementations

impl<T> Clone for Secret<T>

where T: Clone + Zeroize,

fn clone(&self) -> Secret<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Secret<T>

where T: Zeroize,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Secret<T>

where T: Zeroize + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Secret<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Drop for Secret<T>

where T: Zeroize,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for Secret<T>

where T: Zeroize,

fn from(value: T) -> Secret<T>

Converts to this type from the input type.

impl<T> PartialEq for Secret<T>

where T: PartialEq + Zeroize,

fn eq(&self, other: &Secret<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> Serialize for Secret<T>

where T: Zeroize + Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for Secret<T>

where T: Eq + Zeroize,

impl<T> StructuralPartialEq for Secret<T>

where T: Zeroize,