Struct Secret 

pub struct Secret<const N: usize>(/* private fields */);

Generic container for sensitive bytes with best-effort security measures.

In particular this implementation provides:

1. Zeroise memory on drop.
2. Private API methods to retrieve bytes, preventing misuse.
3. Hide bytes value when printing debug info.
4. Constant-time comparison implementation to prevent timing attacks.

This represents a “best-effort” attempt, since side-channels are ultimately a property of a deployed cryptographic system including the hardware it runs on, not just of software.

Trait Implementations

impl<const N: usize> Clone for Secret<N>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Secret<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for Secret<N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Drop for Secret<N>

fn drop(&mut self)

Executes the destructor for this type.

impl From<UpdateSecret> for Secret<RATCHET_KEY_SIZE>

fn from(update_secret: UpdateSecret) -> Self

Converts to this type from the input type.

impl<const N: usize> PartialEq for Secret<N>

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<const N: usize> Serialize for Secret<N>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> Eq for Secret<N>