Struct Salt

pub struct Salt { /* private fields */ }

A salt for HKDF operations.

Implementations

impl Salt

pub fn new(algorithm: Algorithm, value: &[u8]) -> Salt

Constructs a new Salt with the given value based on the given digest algorithm.

Constructing a Salt is relatively expensive so it is good to reuse a Salt object instead of re-constructing Salts with the same value.

Panics

new panics if the salt length exceeds the limit

pub fn extract(&self, secret: &[u8]) -> Prk

The HKDF-Extract operation.

Panics

Panics if the extract operation is unable to be performed

pub fn algorithm(&self) -> Algorithm

The algorithm used to derive this salt.

Trait Implementations

impl Debug for Salt

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

Formats the value using the given formatter.

impl Drop for Salt

fn drop(&mut self)

Executes the destructor for this type.

impl From<Okm<'_, Algorithm>> for Salt

fn from(okm: Okm<'_, Algorithm>) -> Salt

Converts to this type from the input type.