Struct orion::kdf::Salt

pub struct Salt { /* fields omitted */ }

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

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

Errors:

An error will be returned if:

• slice is empty.
• length is 0.
• length is not less than u32::max_value().

Panics:

A panic will occur if:

• Failure to generate random bytes securely.

Methods

impl Salt

#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."] pub fn from_slice(slice: &[u8]) -> Result<Salt, UnknownCryptoError>

Construct from a given byte slice.

pub fn len(&self) -> usize

Return the length of the object.

#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."] pub fn generate(length: usize) -> Result<Salt, UnknownCryptoError>

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

Trait Implementations

impl AsRef<[u8]> for Salt

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

Performs the conversion.

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.

impl Eq for Salt

impl<'_> PartialEq<&'_ [u8]> for Salt

fn eq(&self, other: &&[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Salt> for Salt

fn eq(&self, other: &Salt) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.