Struct async_mailer::Secret

pub struct Secret<S>
where
    S: Zeroize,
{ /* private fields */ }

Wrapper type for values that contains secrets, which attempts to limit accidental exposure and ensure secrets are wiped from memory when dropped. (e.g. passwords, cryptographic keys, access tokens or other credentials)

Access to the secret inner value occurs through the ExposeSecret trait, which provides an expose_secret() method for accessing the inner secret value.

Implementations

impl<S> Secret<S>

where S: Zeroize,

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

Take ownership of a secret value

Trait Implementations

impl<S> Clone for Secret<S>

where S: CloneableSecret,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Secret<S>

where S: Zeroize + DebugSecret,

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

Formats the value using the given formatter.

impl<S> Drop for Secret<S>

where S: Zeroize,

fn drop(&mut self)

Executes the destructor for this type.

impl<S> ExposeSecret<S> for Secret<S>

where S: Zeroize,

fn expose_secret(&self) -> &S

Expose secret: this is the only method providing access to a secret.

impl<S> From<S> for Secret<S>

where S: Zeroize,

fn from(secret: S) -> Secret<S>

Converts to this type from the input type.

impl FromStr for Secret<String>

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str( src: &str ) -> Result<Secret<String>, <Secret<String> as FromStr>::Err>

Parses a string s to return a value of this type.