@@ -15,8 +15,8 @@ A Rust implementation of the [xxHash] algorithm.
15
15
16
16
# Examples
17
17
18
- These examples use [ ` XxHash64 ` ] ( XxHash64 ) but the same ideas can be
19
- used for [ ` XxHash32 ` ] ( XxHash32 ) or [ ` XxHash3_64 ` ] ( XxHash3_64 ) .
18
+ These examples use [ ` XxHash64 ` ] [ ] but the same ideas can be
19
+ used for [ ` XxHash32 ` ] [ ] or [ ` XxHash3_64 ` ] [ ] .
20
20
21
21
## Hashing arbitrary data
22
22
@@ -45,7 +45,7 @@ let hash = hasher.finish();
45
45
assert_eq! (0xeab5_5659_a496_d78b , hash );
46
46
```
47
47
48
- ## In a [ ` HashMap ` ] ( std::collections::HashMap )
48
+ ## In a [ ` HashMap ` ] [ ]
49
49
50
50
### With a default seed
51
51
@@ -80,6 +80,18 @@ hash.insert(42, "the answer");
80
80
assert_eq! (hash . get (& 42 ), Some (& " the answer" ));
81
81
```
82
82
83
+ # Feature Flags
84
+
85
+ | name | description |
86
+ | ------------| ---------------------------------------------------------------------------------------------------------|
87
+ | xxhash32 | Include the [ ` XxHash32 ` ] [ ] algorithm |
88
+ | xxhash64 | Include the [ ` XxHash64 ` ] [ ] algorithm |
89
+ | xxhash3_64 | Include the [ ` XxHash3_64 ` ] [ ] algorithm |
90
+ | random | Create random instances of the hashers |
91
+ | serialize | Serialize and deserialize hasher state with Serde |
92
+ | std | Use the Rust standard library. Enable this if you want SIMD support in [ ` XxHash3_64 ` ] [ ] |
93
+ | alloc | Use the Rust allocator library. Enable this if you want to create [ ` XxHash3_64 ` ] [ ] with dynamic secrets |
94
+
83
95
# Benchmarks
84
96
85
97
See benchmarks in the [ comparison] [ ] README.
@@ -96,3 +108,9 @@ See benchmarks in the [comparison][] README.
96
108
6 . Ensure tests pass.
97
109
7 . Push to the branch (` git push origin my-new-feature ` )
98
110
8 . Create a new Pull Request
111
+
112
+
113
+ [ `Hashmap` ] : std::collections::HashMap
114
+ [ `XxHash32` ] : crate::XxHash32
115
+ [ `XxHash64` ] : crate::XxHash64
116
+ [ `XxHash3_64` ] : crate::XxHash3_64
0 commit comments