Struct SipHasher

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

An implementation of SipHash128 2-4.

SipHash is a general-purpose hashing function: it runs at a good speed (competitive with Spooky and City) and permits strong keyed hashing. This lets you key your hashtables from a strong RNG, such as rand::os::OsRng.

Although the SipHash algorithm is considered to be generally strong, it is not intended for cryptographic purposes. As such, all cryptographic uses of this implementation are strongly discouraged.

Implementations

impl SipHasher

pub fn new() -> SipHasher

Creates a new SipHasher with the two initial keys set to 0.

pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher

Creates a SipHasher that is keyed off the provided keys.

pub fn new_with_key(key: &[u8; 16]) -> SipHasher

Creates a SipHasher from a 16 byte key.

pub fn keys(&self) -> (u64, u64)

Get the keys used by this hasher

pub fn key(&self) -> [u8; 16]

Get the key used by this hasher as a 16 byte vector

pub fn hash(&self, bytes: &[u8]) -> Hash128

Hash a byte array - This is the easiest and safest way to use SipHash.

Trait Implementations

impl Clone for SipHasher

fn clone(&self) -> SipHasher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SipHasher

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SipHasher

fn default() -> SipHasher

Returns the “default value” for a type.

impl Hasher for SipHasher

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

Writes some data into this Hasher.

fn finish(&self) -> u64

Returns the hash value for the values written so far.

fn write_usize(&mut self, i: usize)

Writes a single usize into this hasher.

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_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 Hasher128 for SipHasher

fn finish128(&self) -> Hash128

Return a 128-bit hash

impl Copy for SipHasher