Struct dryoc::generichash::GenericHash

pub struct GenericHash<const KEY_LENGTH: usize, const OUTPUT_LENGTH: usize> { /* private fields */ }

Provides a generic hash function implementation based on Blake2b. Compatible with libsodium’s generic hash.

Implementations

impl<const KEY_LENGTH: usize, const OUTPUT_LENGTH: usize> GenericHash<KEY_LENGTH, OUTPUT_LENGTH>

pub fn new<Key: ByteArray<KEY_LENGTH>>(key: Option<&Key>) -> Result<Self, Error>

Returns a new hasher instance, with key.

pub fn update<Input: Bytes + ?Sized>(&mut self, input: &Input)

Updates the hasher state from input.

pub fn finalize<Output: NewByteArray<OUTPUT_LENGTH>>(
    self
) -> Result<Output, Error>

Computes and returns the final hash value.

pub fn finalize_to_vec(self) -> Result<Vec<u8>, Error>

Computes and returns the final hash value as a Vec. Provided for convenience.

pub fn hash<Input: Bytes + ?Sized, Key: ByteArray<KEY_LENGTH>, Output: NewByteArray<OUTPUT_LENGTH>>(
    input: &Input,
    key: Option<&Key>
) -> Result<Output, Error>

Onet-time interface for the generic hash function. Computes the hash for input with optional key. The output length is determined by the type signature of Output.

Example

use base64::encode;
use dryoc::generichash::{GenericHash, Hash};

let output: Hash =
    GenericHash::hash(b"hello", Some(b"a very secret key")).expect("hash failed");

assert_eq!(
    encode(&output),
    "AECDe+XJsB6nOkbCsbS/OPXdzpcRm3AolW/Bg1LFY9A="
);

pub fn hash_to_vec<Input: Bytes, Key: ByteArray<KEY_LENGTH>>(
    input: &Input,
    key: Option<&Key>
) -> Result<Vec<u8>, Error>

Convenience wrapper for GenericHash::hash.

impl GenericHash<CRYPTO_GENERICHASH_KEYBYTES, CRYPTO_GENERICHASH_BYTES>

pub fn new_with_defaults<Key: ByteArray<CRYPTO_GENERICHASH_KEYBYTES>>(
    key: Option<&Key>
) -> Result<Self, Error>

Returns an instance of GenericHash with the default output and key length parameters.

pub fn hash_with_defaults<Input: Bytes + ?Sized, Key: ByteArray<CRYPTO_GENERICHASH_KEYBYTES>, Output: NewByteArray<CRYPTO_GENERICHASH_BYTES>>(
    input: &Input,
    key: Option<&Key>
) -> Result<Output, Error>

Hashes input using key, with the default length parameters. Provided for convenience.

pub fn hash_with_defaults_to_vec<Input: Bytes + ?Sized, Key: ByteArray<CRYPTO_GENERICHASH_KEYBYTES>>(
    input: &Input,
    key: Option<&Key>
) -> Result<Vec<u8>, Error>

Hashes input using key, with the default length parameters, returning a Vec. Provided for convenience.