Struct Secret

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

A secret string (a password, session token, challenge code, or hash). Use Secret::from to convert a String to a Secret, and secret.expose() to access the string value where necessary.

Secrets are redacted in std::fmt::Debug displays, and are automatically zeroed-out in memory when the value is dropped.

Implementations

impl Secret

pub fn expose(&self) -> &str

Make use of this secret as a &str. This may be needed when sending a secret to the client, or storing a hashed secret in the database.

Trait Implementations

impl Debug for Secret

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Drop for Secret

fn drop(&mut self)

Executes the destructor for this type.

impl From<String> for Secret

fn from(string: String) -> Self

Converts to this type from the input type.

impl ZeroizeOnDrop for Secret