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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
#[cfg(feature = "specialize")]
use crate::HasherExt;
use core::hash::Hash;
use core::hash::Hasher;

#[cfg(not(feature = "std"))]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std as alloc;

#[cfg(feature = "specialize")]
use alloc::string::String;
#[cfg(feature = "specialize")]
use alloc::vec::Vec;

/// Provides a way to get an optimized hasher for a given data type.
/// Rather than using a Hasher generically which can hash any value, this provides a way to get a specialized hash
/// for a specific type. So this may be faster for primitive types. It does however consume the hasher in the process.
/// # Example
/// ```
/// use std::hash::BuildHasher;
/// use ahash::RandomState;
/// use ahash::CallHasher;
///
/// let hash_builder = RandomState::new();
/// //...
/// let value = 17;
/// let hash = u32::get_hash(&value, hash_builder.build_hasher());
/// ```
pub trait CallHasher {
    fn get_hash<H: Hasher>(value: &Self, hasher: H) -> u64;
}

#[cfg(not(feature = "specialize"))]
impl<T> CallHasher for T
where
    T: Hash + ?Sized,
{
    #[inline]
    fn get_hash<H: Hasher>(value: &T, mut hasher: H) -> u64 {
        value.hash(&mut hasher);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl<T> CallHasher for T
where
    T: Hash + ?Sized,
{
    #[inline]
    default fn get_hash<H: Hasher>(value: &T, mut hasher: H) -> u64 {
        value.hash(&mut hasher);
        hasher.finish()
    }
}

macro_rules! call_hasher_impl {
    ($typ:ty) => {
        #[cfg(feature = "specialize")]
        impl CallHasher for $typ {
            #[inline]
            fn get_hash<H: Hasher>(value: &$typ, hasher: H) -> u64 {
                hasher.hash_u64(*value as u64)
            }
        }
        #[cfg(feature = "specialize")]
        impl CallHasher for &$typ {
            #[inline]
            fn get_hash<H: Hasher>(value: &&$typ, hasher: H) -> u64 {
                hasher.hash_u64(**value as u64)
            }
        }
        #[cfg(feature = "specialize")]
        impl CallHasher for &&$typ {
            #[inline]
            fn get_hash<H: Hasher>(value: &&&$typ, hasher: H) -> u64 {
                hasher.hash_u64(***value as u64)
            }
        }
    };
}
call_hasher_impl!(u8);
call_hasher_impl!(u16);
call_hasher_impl!(u32);
call_hasher_impl!(u64);
call_hasher_impl!(i8);
call_hasher_impl!(i16);
call_hasher_impl!(i32);
call_hasher_impl!(i64);

#[cfg(feature = "specialize")]
impl CallHasher for u128 {
    #[inline]
    fn get_hash<H: Hasher>(value: &u128, mut hasher: H) -> u64 {
        hasher.write_u128(*value);
        hasher.short_finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &u128 {
    #[inline]
    fn get_hash<H: Hasher>(value: &&u128, mut hasher: H) -> u64 {
        hasher.write_u128(**value);
        hasher.short_finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &&u128 {
    #[inline]
    fn get_hash<H: Hasher>(value: &&&u128, mut hasher: H) -> u64 {
        hasher.write_u128(***value);
        hasher.short_finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for i128 {
    #[inline]
    fn get_hash<H: Hasher>(value: &i128,  mut hasher: H) -> u64 {
        hasher.write_u128(*value as u128);
        hasher.short_finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &i128 {
    #[inline]
    fn get_hash<H: Hasher>(value: &&i128,  mut hasher: H) -> u64 {
        hasher.write_u128(**value as u128);
        hasher.short_finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &&i128 {
    #[inline]
    fn get_hash<H: Hasher>(value: &&&i128,  mut hasher: H) -> u64 {
        hasher.write_u128(***value as u128);
        hasher.short_finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for [u8] {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &[u8] {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(*value);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &&[u8] {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(**value);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for Vec<u8> {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &Vec<u8> {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(*value);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &&Vec<u8> {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(**value);
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for str {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &str {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &&str {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(feature = "specialize")]
impl CallHasher for &&&str {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(all(feature = "specialize"))]
impl CallHasher for String {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(all(feature = "specialize"))]
impl CallHasher for &String {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(all(feature = "specialize"))]
impl CallHasher for &&String {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(all(feature = "specialize"))]
impl CallHasher for &&&String {
    #[inline]
    fn get_hash<H: Hasher>(value: &Self, mut hasher: H) -> u64 {
        hasher.write(value.as_bytes());
        hasher.finish()
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::*;

    #[test]
    #[cfg(feature = "specialize")]
    pub fn test_specialized_invoked() {
        let shortened = u64::get_hash(&0, AHasher::new_with_keys(1, 2));
        let mut hasher = AHasher::new_with_keys(1, 2);
        0_u64.hash(&mut hasher);
        assert_ne!(hasher.finish(), shortened);
    }

    /// Tests that some non-trivial transformation takes place.
    #[test]
    pub fn test_input_processed() {
        let hasher = || AHasher::new_with_keys(3, 2);
        assert_ne!(0, u64::get_hash(&0, hasher()));
        assert_ne!(1, u64::get_hash(&0, hasher()));
        assert_ne!(2, u64::get_hash(&0, hasher()));
        assert_ne!(3, u64::get_hash(&0, hasher()));
        assert_ne!(4, u64::get_hash(&0, hasher()));
        assert_ne!(5, u64::get_hash(&0, hasher()));

        assert_ne!(0, u64::get_hash(&1, hasher()));
        assert_ne!(1, u64::get_hash(&1, hasher()));
        assert_ne!(2, u64::get_hash(&1, hasher()));
        assert_ne!(3, u64::get_hash(&1, hasher()));
        assert_ne!(4, u64::get_hash(&1, hasher()));
        assert_ne!(5, u64::get_hash(&1, hasher()));

        let xored = u64::get_hash(&0, hasher()) ^ u64::get_hash(&1, hasher());
        assert_ne!(0, xored);
        assert_ne!(1, xored);
        assert_ne!(2, xored);
        assert_ne!(3, xored);
        assert_ne!(4, xored);
        assert_ne!(5, xored);
    }

    #[test]
    pub fn test_ref_independent() {
        let hasher = || AHasher::new_with_keys(3, 2);
        assert_eq!(<&u8>::get_hash(&&1, hasher()), u8::get_hash(&1, hasher()));
        assert_eq!(<&u16>::get_hash(&&2, hasher()), u16::get_hash(&2, hasher()));
        assert_eq!(<&u32>::get_hash(&&3, hasher()), u32::get_hash(&3, hasher()));
        assert_eq!(<&u64>::get_hash(&&4, hasher()), u64::get_hash(&4, hasher()));
        assert_eq!(<&u128>::get_hash(&&5, hasher()), u128::get_hash(&5, hasher()));
        assert_eq!(<&str>::get_hash(&"test", hasher()), str::get_hash("test", hasher()));
        assert_eq!(<&str>::get_hash(&"test", hasher()), String::get_hash(&"test".to_string(), hasher()));
        #[cfg(feature = "specialize")]
        assert_eq!(<&str>::get_hash(&"test", hasher()), <[u8]>::get_hash("test".as_bytes(), hasher()));

        let hasher = || AHasher::new_with_keys(3, 2);
        assert_eq!(<&&u8>::get_hash(&&&1, hasher()), u8::get_hash(&1, hasher()));
        assert_eq!(<&&u16>::get_hash(&&&2, hasher()), u16::get_hash(&2, hasher()));
        assert_eq!(<&&u32>::get_hash(&&&3, hasher()), u32::get_hash(&3, hasher()));
        assert_eq!(<&&u64>::get_hash(&&&4, hasher()), u64::get_hash(&4, hasher()));
        assert_eq!(<&&u128>::get_hash(&&&5, hasher()), u128::get_hash(&5, hasher()));
        assert_eq!(<&&str>::get_hash(&&"test", hasher()), str::get_hash("test",hasher()));
        assert_eq!(<&&str>::get_hash(&&"test", hasher()), String::get_hash(&"test".to_string(), hasher()));
        #[cfg(feature = "specialize")]
        assert_eq!(<&&str>::get_hash(&&"test", hasher()), <[u8]>::get_hash(&"test".to_string().into_bytes(), hasher()));
    }
}