Struct Params

pub struct Params { /* private fields */ }

A parameter builder for BLAKE2sp, just like the Params type for BLAKE2s.

This builder only supports configuring the hash length and a secret key. This matches the options provided by the reference implementation.

Example

use blake2s_simd::blake2sp;
let mut state = blake2sp::Params::new().hash_length(32).to_state();

Implementations

impl Params

pub fn new() -> Self

Equivalent to Params::default().

pub fn hash(&self, input: &[u8]) -> Hash

Hash an input all at once with these parameters.

pub fn to_state(&self) -> State

Construct a BLAKE2sp State object based on these parameters.

pub fn hash_length(&mut self, length: usize) -> &mut Self

Set the length of the final hash, from 1 to OUTBYTES (64). Apart from controlling the length of the final Hash, this is also associated data, and changing it will result in a totally different hash.

pub fn key(&mut self, key: &[u8]) -> &mut Self

Use a secret key, so that BLAKE2sp acts as a MAC. The maximum key length is KEYBYTES (64). An empty key is equivalent to having no key at all.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Self

Returns the “default value” for a type.