Struct RapidHasher

pub struct RapidHasher(/* private fields */);

A Hasher trait compatible hasher that uses the rapidhash algorithm.

See RapidInlineHasher for an #[inline(always)] version of this hasher, which can deliver speed improvements of around 30% when hashing complex objects.

See RapidHashBuilder for usage with std::collections::HashMap.

Example

use std::hash::Hasher;
use rapidhash::RapidHasher;

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

Implementations

impl RapidHasher

pub const DEFAULT_SEED: u64 = 13_679_853_920_966_426_665u64

Default RapidHasher seed.

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

Create a new RapidHasher with a custom seed.

pub const fn default_const() -> Self

Create a new RapidHasher using the default seed.

pub const fn write_const(&self, bytes: &[u8]) -> Self

Const equivalent to Hasher::write.

Example

use rapidhash::RapidHasher;

let hasher = RapidHasher::default_const();
let hash = hasher
    .write_const(b"some bytes")
    .write_const(b"and some more bytes")
    .finish_const();

pub const fn finish_const(&self) -> u64

Const equivalent to Hasher::finish.

Trait Implementations

impl Clone for RapidHasher

fn clone(&self) -> RapidHasher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RapidHasher

fn default() -> Self

Create a new RapidHasher with the default seed.

See crate::RapidRandomState for a std::hash::BuildHasher that initialises with a random seed.

impl Hasher for RapidHasher

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 write(&mut self, bytes: &[u8])

Write a byte slice to the hasher.

fn finish(&self) -> u64

Returns the hash value for the values written so far.

fn write_u8(&mut self, i: u8)

Writes a single u8 into this hasher.

fn write_u16(&mut self, i: u16)

Writes a single u16 into this hasher.

fn write_u32(&mut self, i: u32)

Writes a single u32 into this hasher.

fn write_u64(&mut self, i: u64)

Writes a single u64 into this hasher.

fn write_u128(&mut self, i: u128)

Writes a single u128 into this hasher.

fn write_usize(&mut self, i: usize)

Writes a single usize into this hasher.

fn write_i8(&mut self, i: i8)

Writes a single i8 into this hasher.

fn write_i16(&mut self, i: i16)

Writes a single i16 into this hasher.

fn write_i32(&mut self, i: i32)

Writes a single i32 into this hasher.

fn write_i64(&mut self, i: i64)

Writes a single i64 into this hasher.

fn write_i128(&mut self, i: i128)

Writes a single i128 into this hasher.

fn write_isize(&mut self, i: isize)

Writes a single isize into this hasher.

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.

impl PartialEq for RapidHasher

fn eq(&self, other: &RapidHasher) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RapidHasher

impl Eq for RapidHasher

impl StructuralPartialEq for RapidHasher