Struct SecretBox

pub struct SecretBox<T>(/* private fields */)
where
    T: Zeroize + Clone;

A container for secret data. Makes the usage of secret data explicit and easy to track, prevents the secret data from being put on stack, and zeroizes the contents on drop.

Implementations

impl<T> SecretBox<T>

where T: Zeroize + Clone,

pub fn as_secret(&self) -> &T

Returns an immutable reference to the secret data.

pub fn as_mut_secret(&mut self) -> &mut T

Returns a mutable reference to the secret data.

Trait Implementations

impl<T> Clone for SecretBox<T>

where T: Zeroize + Clone + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Drop for SecretBox<T>

where T: Zeroize + Clone,

fn drop(&mut self)

Executes the destructor for this type.

impl<T: PartialEq + Zeroize + Clone> PartialEq for SecretBox<T>

fn eq(&self, other: &Self) -> 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> ZeroizeOnDrop for SecretBox<T>

where T: Zeroize + Clone,