Struct Secret 

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

A secret value whose formatted representations never reveal its contents.

The inner value is zeroized when the wrapper is dropped. Access is deliberately named Secret::expose so reviews can find places where secrets are revealed.

Implementations

impl<T: Zeroize> Secret<T>

pub fn new(value: T) -> Self

Wraps a value as a secret.

pub fn expose(&self) -> &T

Deliberately exposes a shared reference to the secret value.

Trait Implementations

impl<T> Clone for Secret<T>

where T: Clone + Zeroize,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Zeroize> Debug for Secret<T>

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

Formats the value using the given formatter.

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

where T: Deserialize<'de> + Zeroize,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Zeroize> Display for Secret<T>

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

Formats the value using the given formatter.

impl<T: Zeroize> Drop for Secret<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.