Struct ahash::AHasher

pub struct AHasher { /* fields omitted */ }

A Hasher for hashing an arbitrary stream of bytes.

Instances of AHasher represent state that is updated while hashing data.

Each method updates the internal state based on the new data provided. Once all of the data has been provided, the resulting hash can be obtained by calling finish()

Clone is also provided in case you wish to calculate hashes for two different items that start with the same data.

Methods

impl AHasher

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

Creates a new hasher keyed to the provided keys.

Example

use std::hash::Hasher;
use ahash::AHasher;

let mut hasher = AHasher::new_with_keys(123, 456);

hasher.write_u32(1989);
hasher.write_u8(11);
hasher.write_u8(9);
hasher.write(b"Huh?");

println!("Hash is {:x}!", hasher.finish());

Trait Implementations

impl Clone for AHasher

fn clone(&self) -> AHasher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AHasher

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

Formats the value using the given formatter.

impl Default for AHasher

Provides a default Hasher compile time generated constants for keys. This is typically used in conjunction with [BuildHasherDefault] to create AHashers in order to hash the keys of the map.

Example

use std::hash::BuildHasherDefault;
use ahash::{AHasher, RandomState};
use std::collections::HashMap;

let mut map: HashMap<i32, i32, RandomState> = HashMap::default();
map.insert(12, 34);

fn default() -> AHasher

Constructs a new AHasher with compile time generated constants for keys. This means the keys will be the same from one instance to another, but different from build to the next. So if it is possible for a potential attacker to have access to the compiled binary it would be better to specify keys generated at runtime.

This is defined only if the compile-time-rng feature is enabled.

Examples

use ahash::AHasher;
use std::hash::Hasher;

let mut hasher_1 = AHasher::default();
let mut hasher_2 = AHasher::default();

hasher_1.write_u32(1234);
hasher_2.write_u32(1234);

assert_eq!(hasher_1.finish(), hasher_2.finish());

impl Hasher for AHasher

Provides methods to hash all of the primitive types.

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_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_u64(&mut self, i: u64)

Writes a single u64 into this hasher.

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

Writes some data into this Hasher.

fn finish(&self) -> u64

Returns the hash value for the values written so far.

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.