Struct EphemeralSecret 

pub struct EphemeralSecret<T: Zeroize> { /* private fields */ }

Ephemeral secret that invokes explicit clearing on drop.

This type wraps a value and invokes its Zeroize implementation on drop. It is useful for temporary secrets and intermediate cryptographic values, subject to the module-level limits of best-effort software clearing.

Implementations

impl<T: Zeroize> EphemeralSecret<T>

pub fn new(value: T) -> Self

Create a new ephemeral secret

pub fn into_inner(self) -> T

Consume the secret and return the inner value

Note: after calling this method, the caller owns the value and is responsible for invoking its clearing policy when appropriate.

Trait Implementations

impl<T: Zeroize> AsMut<T> for EphemeralSecret<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: Zeroize> AsRef<T> for EphemeralSecret<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Zeroize + Clone> Clone for EphemeralSecret<T>

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 EphemeralSecret<T>

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

Formats the value using the given formatter.

impl<T: Zeroize + Default> Default for EphemeralSecret<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Zeroize> Deref for EphemeralSecret<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Zeroize> DerefMut for EphemeralSecret<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Zeroize> Drop for EphemeralSecret<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.