Struct IV

pub struct IV { /* private fields */ }

Initialization vector for a Blake3 hasher, if BlockHasher::new() or HashTreeBuilder::new() are not sufficient for you and you need more customization on the IV, such as keyed hash function, you can achieve it by constructing the IV first using a method like IV::new_keyed and convert it to either of these by simply using the Into trait.

Implementations

impl IV

pub const fn new() -> Self

Create a new IV from the default configurations. This is the equivalent IV of creating a Hasher::new().

pub fn new_keyed(key: &[u8; 32]) -> Self

The keyed hash function.

This is suitable for use as a message authentication code, for example to replace an HMAC instance. In that use case, the constant-time equality checking provided by Hash is almost always a security requirement, and callers need to be careful not to compare MACs as raw bytes.

pub fn new_derive_key(context: &str) -> Self

The key derivation function.

Given cryptographic key material of any length and a context string of any length, this function outputs a 32-byte derived subkey. The context string should be hardcoded, globally unique, and application-specific. A good default format for such strings is "[application] [commit timestamp] [purpose]", e.g., "example.com 2019-12-25 16:18:03 session tokens v1".

Key derivation is important when you want to use the same key in multiple algorithms or use cases. Using the same key with different cryptographic algorithms is generally forbidden, and deriving a separate subkey for each use case protects you from bad interactions. Derived keys also mitigate the damage from one part of your application accidentally leaking its key.

impl IV

pub fn merge( &self, left: &[u8; 32], right: &[u8; 32], is_root: bool, ) -> [u8; 32]

Merge two children into the parent hash, the is_root determines if the result is the finalized hash.

Trait Implementations

impl Clone for IV

fn clone(&self) -> IV

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for IV

fn default() -> Self

Returns the “default value” for a type.

impl From<IV> for BlockHasher

fn from(value: IV) -> Self

Converts to this type from the input type.

impl From<IV> for HashTreeBuilder

fn from(value: IV) -> Self

Converts to this type from the input type.

impl Copy for IV