bitcoin-hash 0.1.20

tools and context for hashing bytes
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

// ---------------- [ File: bitcoin-hash/src/bytevectorhash.rs ]
crate::ix!();

//-------------------------------------------[.cpp/bitcoin/src/util/bytevectorhash.h]
//-------------------------------------------[.cpp/bitcoin/src/util/bytevectorhash.cpp]

/**
  | Implementation of Hash named requirement
  | for types that internally store a byte
  | array. This may be used as the hash function
  | in std::unordered_set or std::unordered_map
  | over such types.
  | 
  | Internally, this uses a random instance
  | of SipHash-2-4.
  |
  */
#[derive(Debug,Clone)]
pub struct ByteVectorHash {
    k0:     u64,
    k1:     u64,
    hasher: SipHasher,
}

impl Default for ByteVectorHash {
    /// Generates process‑wide random SipHash keys.
    #[instrument(level = "trace")]
    fn default() -> Self {
        let mut rng = rand::rngs::OsRng::default();
        let k0 = rng.next_u64();
        let k1 = rng.next_u64();
        Self {
            k0,
            k1,
            hasher: SipHasher::new_with_keys(k0, k1),
        }
    }
}

impl BuildHasher for ByteVectorHash {
    type Hasher = Self;

    #[instrument(level = "trace")]
    fn build_hasher(&self) -> Self::Hasher {
        Self {
            k0:     self.k0,
            k1:     self.k1,
            hasher: SipHasher::new_with_keys(self.k0, self.k1),
        }
    }
}

impl Hasher for ByteVectorHash {
    #[inline]
    fn finish(&self) -> u64 {
        self.hasher.clone().finish()
    }

    #[inline]
    fn write(&mut self, bytes: &[u8]) {
        self.hasher.write(bytes);
    }
}

impl ByteVectorHash {

    /// Convenience helper that hashes a complete byte‑vector in one call.
    #[instrument(level = "trace", skip_all)]
    pub fn invoke(&self, input: &[u8]) -> usize {
        let mut h = SipHasher::new_with_keys(self.k0, self.k1);
        h.write(input);
        h.finish() as usize
    }
}

// ---------------- [ File: bitcoin-hash/src/bytevectorhash.rs ] (new test module)
#[cfg(test)]
mod bytevectorhash_spec {
    use super::*;

    #[traced_test]
    fn identical_inputs_yield_identical_hashes() {
        let h = ByteVectorHash::default();
        let lhs = h.invoke(b"hello");
        let rhs = h.invoke(b"hello");
        assert_eq!(lhs, rhs);
    }

    #[traced_test]
    fn distinct_inputs_yield_distinct_hashes() {
        let h = ByteVectorHash::default();
        let lhs = h.invoke(b"hello");
        let rhs = h.invoke(b"good-bye");
        assert_ne!(lhs, rhs);
    }

    #[traced_test]
    fn build_hasher_produces_equivalent_hasher() {
        let builder = ByteVectorHash::default();
        let mut h1 = builder.build_hasher();
        h1.write(b"test");
        let r1 = h1.finish();

        let mut h2 = builder.build_hasher();
        h2.write(b"test");
        let r2 = h2.finish();

        assert_eq!(r1, r2);
    }
}