Struct Hasher

pub struct Hasher { /* private fields */ }

Available on crate feature xxhash3_128 only.

Calculates the 128-bit hash. TODO: does not implement hash.

Implementations

impl Hasher

pub fn new() -> Self

Available on crate feature alloc only.

Constructs the hasher using the default seed and secret values.

pub fn with_seed(seed: u64) -> Self

Available on crate feature alloc only.

Constructs the hasher using the provided seed and a secret derived from the seed.

pub fn with_seed_and_secret( seed: u64, secret: impl Into<Box<[u8]>>, ) -> Result<Self, SecretTooShortError<Box<[u8]>>>

Available on crate feature alloc only.

Constructs the hasher using the provided seed and secret.

pub fn into_secret(self) -> Box<[u8]>

Available on crate feature alloc only.

Returns the secret.

pub fn write(&mut self, input: &[u8])

Available on crate feature alloc only.

Writes some data into this Hasher.

pub fn finish_128(&self) -> u128

Available on crate feature alloc only.

Returns the hash value for the values written so far. Unlike std::hash::Hasher::finish, this method returns the complete 128-bit value calculated, not a 64-bit value.

impl Hasher

pub fn oneshot(input: &[u8]) -> u128

Hash all data at once. If you can use this function, you may see noticable speed gains for certain types of input.

pub fn oneshot_with_seed(seed: u64, input: &[u8]) -> u128

Hash all data at once using the provided seed and a secret derived from the seed. If you can use this function, you may see noticable speed gains for certain types of input.

pub fn oneshot_with_secret( secret: &[u8], input: &[u8], ) -> Result<u128, OneshotWithSecretError>

Hash all data at once using the provided secret and the default seed. If you can use this function, you may see noticable speed gains for certain types of input.

pub fn oneshot_with_seed_and_secret( seed: u64, secret: &[u8], input: &[u8], ) -> Result<u128, OneshotWithSecretError>

Hash all data at once using the provided seed and secret. If you can use this function, you may see noticable speed gains for certain types of input.

Trait Implementations

impl Clone for Hasher

fn clone(&self) -> Hasher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Hasher

Available on crate feature alloc only.

fn default() -> Self

Returns the “default value” for a type.