Struct RapidHasher 

pub struct RapidHasher<'s, const AVALANCHE: bool, const SPONGE: bool, const COMPACT: bool = false, const PROTECTED: bool = false> { /* private fields */ }

A Hasher trait compatible hasher that uses the rapidhash algorithm, and uses #[inline(always)] for all methods.

Using #[inline(always)] can deliver a large performance improvement when hashing complex objects, but should be benchmarked for your specific use case. If you have HashMaps for many different types this may come at the cost of some binary size increase.

See crate::fast::RandomState for usage with [std::collections::HashMap].

Example

use std::hash::Hasher;

use rapidhash::quality::RapidHasher;

let mut hasher = RapidHasher::default();
hasher.write(b"hello world");
let hash = hasher.finish();

Implementations

impl<'s, const AVALANCHE: bool, const SPONGE: bool, const COMPACT: bool, const PROTECTED: bool> RapidHasher<'s, AVALANCHE, SPONGE, COMPACT, PROTECTED>

pub const DEFAULT_SEED: u64 = super::seed::DEFAULT_SEED

Default RapidHasher seed.

pub const fn new(seed: u64) -> Self

Create a new RapidHasher with a custom seed.

See instead crate::quality::RandomState::new or crate::fast::RandomState::new for a random seed and random secret initialization, for minimal DoS resistance.

pub const fn default_const() -> Self

Create a new RapidHasher using the default seed and secrets.

Trait Implementations

impl<'s, const AVALANCHE: bool, const SPONGE: bool, const COMPACT: bool, const PROTECTED: bool> Clone for RapidHasher<'s, AVALANCHE, SPONGE, COMPACT, PROTECTED>

fn clone(&self) -> RapidHasher<'s, AVALANCHE, SPONGE, COMPACT, PROTECTED>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'s, const AVALANCHE: bool, const SPONGE: bool, const COMPACT: bool, const PROTECTED: bool> Copy for RapidHasher<'s, AVALANCHE, SPONGE, COMPACT, PROTECTED>

impl<const AVALANCHE: bool, const SPONGE: bool, const COMPACT: bool, const PROTECTED: bool> Default for RapidHasher<'_, AVALANCHE, SPONGE, COMPACT, PROTECTED>

fn default() -> Self

Create a new RapidHasher with the default seed.

See crate::inner::RandomState for a [std::hash::BuildHasher] that initializes with a random seed.

impl<const AVALANCHE: bool, const SPONGE: bool, const COMPACT: bool, const PROTECTED: bool> Hasher for RapidHasher<'_, AVALANCHE, SPONGE, COMPACT, PROTECTED>

This implementation implements methods for all integer types as the compiler will (hopefully…) inline and heavily optimize the rapidhash_core for each. Where the bytes length is known the compiler can make significant optimisations and saves us writing them out by hand.

fn finish(&self) -> u64

Produce the final hash value, marked as #[inline(always)].

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

Write a byte slice to the hasher, marked as #[inline(always)].

fn write_u8(&mut self, i: u8)

Write an integer to the hasher, marked as #[inline(always)].

fn write_u16(&mut self, i: u16)

Write an integer to the hasher, marked as #[inline(always)].

fn write_u32(&mut self, i: u32)

Write an integer to the hasher, marked as #[inline(always)].

fn write_u64(&mut self, i: u64)

Write an integer to the hasher, marked as #[inline(always)].

fn write_usize(&mut self, i: usize)

Write an integer to the hasher, marked as #[inline(always)].

fn write_i8(&mut self, i: i8)

Write an integer to the hasher, marked as #[inline(always)].

fn write_i16(&mut self, i: i16)

Write an integer to the hasher, marked as #[inline(always)].

fn write_i32(&mut self, i: i32)

Write an integer to the hasher, marked as #[inline(always)].

fn write_i64(&mut self, i: i64)

Write an integer to the hasher, marked as #[inline(always)].

fn write_isize(&mut self, i: isize)

Write an integer to the hasher, marked as #[inline(always)].

fn write_u128(&mut self, i: u128)

Write an int to the hasher, marked as #[inline(always)].

fn write_i128(&mut self, i: i128)

Write an int to the hasher, marked as #[inline(always)].

fn write_length_prefix(&mut self, len: usize)

🔬This is a nightly-only experimental API. (hasher_prefixfree_extras)

Writes a length prefix into this hasher, as part of being prefix-free.

fn write_str(&mut self, s: &str)

🔬This is a nightly-only experimental API. (hasher_prefixfree_extras)

Writes a single str into this hasher.