blake3

View Source Blake3 (blake3 v1.0.2)

Blake3 provides bindings to the rust implementaion of the BLAKE3 hashing algorithm. See the README for installation and usage examples

Link to this section Summary

Types

hasher()

Functions

derive_key(key)

same as derive_key/2 but uses an empty string for context

derive_key(context, key)

returns a 32 byte key for use for hash_keyed or new_keyed from the given context and key. for more information: crate

finalize(state)

returns the binary of the current hash state for a given hasher

hash(data)

computes a message digest for the given data

keyed_hash(key, data)

computes a message digest for the given data and key. The key must be 32 bytes. if you need to use a key of a diffrent size you can use derive_key to get a key of a proper size.

new()

returns a new reference for a Blake3 hasher to be used for streaming calls with update/2

new_keyed(key)

returns a new reference for a Blake3 hasher using the passed key to be used for streaming calls with update/2

reset(state)

reset a hasher to the default stat like when calling Blake3.new

update(state, data)

updates the hasher with the given data to be hashed the the refernce can be continouly passed to update/2 or when finished to finalize/1

update_rayon(state, data)

updates state with the potential to multithreading. The rayon feature needs to be enabled and the input need to be large enough. for more information see: documentation

Link to this section Types

Link to this type

hasher()

View Source 
@type hasher() :: reference()

Link to this section Functions

Link to this function

derive_key(key)

View Source 
@spec derive_key(key :: binary()) :: binary()
@spec derive_key(state :: hasher()) :: hasher()

same as derive_key/2 but uses an empty string for context

Link to this function

derive_key(context, key)

View Source 
@spec derive_key(context :: binary(), key :: binary()) :: binary()

returns a 32 byte key for use for hash_keyed or new_keyed from the given context and key. for more information: crate

Link to this function

finalize(state)

View Source 
@spec finalize(state :: hasher()) :: binary()

returns the binary of the current hash state for a given hasher

Link to this function

hash(data)

View Source 
@spec hash(data :: binary()) :: binary()

computes a message digest for the given data

Link to this function

keyed_hash(key, data)

View Source 
@spec keyed_hash(key :: binary(), data :: binary()) :: binary() | {:error, String.t()}

computes a message digest for the given data and key. The key must be 32 bytes. if you need to use a key of a diffrent size you can use derive_key to get a key of a proper size.

Link to this function

new()

View Source 
@spec new() :: hasher()

returns a new reference for a Blake3 hasher to be used for streaming calls with update/2

Link to this function

new_keyed(key)

View Source 
@spec new_keyed(key :: binary()) :: hasher() | {:error, String.t()}

returns a new reference for a Blake3 hasher using the passed key to be used for streaming calls with update/2

Link to this function

reset(state)

View Source

reset a hasher to the default stat like when calling Blake3.new

Link to this function

update(state, data)

View Source 
@spec update(state :: hasher(), data :: binary()) :: hasher()

updates the hasher with the given data to be hashed the the refernce can be continouly passed to update/2 or when finished to finalize/1

Link to this function

update_rayon(state, data)

View Source 
@spec update_rayon(state :: hasher(), data :: binary()) :: hasher()

updates state with the potential to multithreading. The rayon feature needs to be enabled and the input need to be large enough. for more information see: documentation