Struct orion::kdf::Salt

pub struct Salt { /* private fields */ }

A type to represent the Salt that PBKDF2 uses during key derivation.

As default it will randomly generate a Salt of 64 bytes.

Note:

Due to the return type of the Default trait, the default() method cannot let the caller handle a failing CSPRNG. If the CSPRNG fails, that function panics. If handling a failing CSPRNG’s error is needed, use instead generate().

Exceptions:

An exception will be thrown if:

• slice is empty.
• The OsRng fails to initialize or read from its source.
• length is 0.
• length is not less than u32::max_value().

Implementations

impl Salt

pub fn from_slice(slice: &[u8]) -> Result<Salt, UnknownCryptoError>

Make an object from a given byte slice.

pub fn as_bytes(&self) -> &[u8]

Return the object as byte slice.

pub fn get_length(&self) -> usize

Return the length of the object.

pub fn generate(length: usize) -> Result<Salt, UnknownCryptoError>

Randomly generate using a CSPRNG. Not available in no_std context.

Trait Implementations

impl Debug for Salt

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

Formats the value using the given formatter.

impl Default for Salt

fn default() -> Salt

Randomly generate using a CSPRNG with recommended size. Not available in no_std context.