Struct SecretValue

pub struct SecretValue<L: ArrayLength<u8>>(/* private fields */);

Represents a secret value of a fixed length that is zeroized on drop. Secret values are always compared in constant time. The default value is all zeroes.

Implementations

impl<L: ArrayLength<u8>> SecretValue<L>

pub const LENGTH: usize = L::USIZE

Length of the secret value in bytes.

pub fn random() -> Self

Generates cryptographically strong random secret value.

Trait Implementations

impl<L: ArrayLength<u8>> AsMut<[u8]> for SecretValue<L>

fn as_mut(&mut self) -> &mut [u8]

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

impl<L: ArrayLength<u8>> AsRef<[u8]> for SecretValue<L>

fn as_ref(&self) -> &[u8]

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

impl<L: Clone + ArrayLength<u8>> Clone for SecretValue<L>

fn clone(&self) -> SecretValue<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: ArrayLength<u8>> ConstantTimeEq for SecretValue<L>

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<L: ArrayLength<u8>> Default for SecretValue<L>

fn default() -> Self

Returns the “default value” for a type.

impl<L: ArrayLength<u8>> Drop for SecretValue<L>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, L: ArrayLength<u8>> From<&'a SecretValue<L>> for &'a GenericArray<u8, L>

fn from(value: &'a SecretValue<L>) -> Self

Converts to this type from the input type.

impl<L: ArrayLength<u8>> From<GenericArray<u8, L>> for SecretValue<L>

fn from(value: GenericArray<u8, L>) -> Self

Converts to this type from the input type.

impl<L: ArrayLength<u8>> From<SecretValue<L>> for Box<[u8]>

fn from(value: SecretValue<L>) -> Self

Converts to this type from the input type.

impl<L: ArrayLength<u8>> TryFrom<&[u8]> for SecretValue<L>

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<L: ArrayLength<u8>> Zeroize for SecretValue<L>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.