axhash-core 0.8.2

Platform-agnostic AxHash core for Rust with no_std compatibility.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

use core::hash::BuildHasher;

use crate::constants::SECRET;

use super::AxHasher;

// A [`BuildHasher`] that constructs [`AxHasher`] instances.
//
// Use this type as the hasher factory for `HashMap`, `HashSet`, and any
// other collection that accepts a custom `BuildHasher`.
//
// # Seeding
//
// [`AxBuildHasher::new`] uses an internal constant as the seed. For
// hash-flooding resistance supply your own seed with
// [`AxBuildHasher::with_seed`].
//
// # Example
//
// ```rust
// use std::collections::HashMap;
// use axhash_core::AxBuildHasher;
//
// // Fixed seed — deterministic across runs.
// let mut map: HashMap<&str, u32, AxBuildHasher> =
//     HashMap::with_hasher(AxBuildHasher::with_seed(0xfeed_beef));
// map.insert("alpha", 1);
// map.insert("beta",  2);
// assert_eq!(map["alpha"], 1);
// ```
#[derive(Clone, Copy, Default)]
pub struct AxBuildHasher {
    pub(crate) prepared_seed: u64,
}

impl AxBuildHasher {
    // Creates an `AxBuildHasher` using the library's built-in default seed.
    //
    // The output is deterministic for a given input but the seed value itself
    // is an internal constant and may change between crate versions.
    #[inline(always)]
    pub const fn new() -> Self {
        Self {
            prepared_seed: SECRET[0],
        }
    }

    // Creates an `AxBuildHasher` with a caller-supplied `seed`.
    //
    // Use a random 64-bit value (e.g. from `rand` or OS entropy) to achieve
    // per-process hash randomisation and resist hash-flooding attacks.
    //
    // # Example
    //
    // ```rust
    // use axhash_core::AxBuildHasher;
    //
    // let bh = AxBuildHasher::with_seed(0x0123_4567_89ab_cdef);
    // ```
    #[inline(always)]
    pub const fn with_seed(seed: u64) -> Self {
        Self {
            prepared_seed: seed ^ SECRET[0],
        }
    }
}

impl BuildHasher for AxBuildHasher {
    type Hasher = AxHasher;

    #[inline(always)]
    fn build_hasher(&self) -> Self::Hasher {
        AxHasher {
            acc: self.prepared_seed,
            sponge: 0,
            sponge_bits: 0,
        }
    }
}