Struct Secret 

pub struct Secret<T: Zeroize = Box<[u8]>, E = Base64UrlUnpadded>(/* private fields */);

A serde wrapper for base64-encoded secrets.

A secret is like the Bytes type, with some additional protections:

1. It is zeroed on drop.
2. Its equality implementation is constant time.
3. Its contents are not printed in the debug formatter.

Trait Implementations

impl<T: Zeroize, U, E> AsMut<U> for Secret<T, E>

where Bytes<T, E>: AsMut<U>,

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

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

impl<T: Zeroize, U, E> AsRef<U> for Secret<T, E>

where Bytes<T, E>: AsRef<U>,

fn as_ref(&self) -> &U

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

impl<T: Clone + Zeroize, E: Clone> Clone for Secret<T, E>

fn clone(&self) -> Secret<T, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Zeroize + AsRef<[u8]> + Sized, E> ConstantTimeEq for Secret<T, E>

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

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

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

Formats the value using the given formatter.

impl<T: Zeroize + Default, E> Default for Secret<T, E>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Zeroize, E> DerefMut for Secret<T, E>

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

Mutably dereferences the value.

impl<'de, T: Zeroize, E> Deserialize<'de> for Secret<T, E>

where Bytes<T, E>: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Zeroize, U: Into<Bytes<T, E>>, E> From<U> for Secret<T, E>

fn from(value: U) -> Self

Converts to this type from the input type.

impl<T: Zeroize + AsRef<[u8]>, E> PartialEq for Secret<T, E>

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: Zeroize, E> Serialize for Secret<T, E>

where Bytes<T, E>: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Zeroize, E> Deref for Secret<T, E>

type Target = Bytes<T, E>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Zeroize + AsRef<[u8]>, E> Eq for Secret<T, E>