https://github.com/doumanash/xxhash-rust
Rust implementation of xxhash
https://github.com/doumanash/xxhash-rust
hash rust xxhash
Last synced: 24 days ago
JSON representation
Rust implementation of xxhash
- Host: GitHub
- URL: https://github.com/doumanash/xxhash-rust
- Owner: DoumanAsh
- License: bsl-1.0
- Created: 2020-10-12T13:44:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-30T00:30:35.000Z (5 months ago)
- Last Synced: 2025-04-13T04:56:46.988Z (about 2 months ago)
- Topics: hash, rust, xxhash
- Language: Rust
- Homepage:
- Size: 286 KB
- Stars: 228
- Watchers: 6
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xxhash-rust
[](https://github.com/DoumanAsh/xxhash-rust/actions/workflows/rust.yml)
[](https://crates.io/crates/xxhash-rust)
[](https://docs.rs/crate/xxhash-rust/)
Implementation of [xxHash](https://github.com/Cyan4973/xxHash) in Rust
Each algorithm is implemented via feature, allowing precise control over code size.
## Example
- Cargo.toml
```toml
[dependencies.xxhash-rust]
version = "0.8.12"
features = ["xxh3", "const_xxh3"]
```
- main.rs
```rust
use xxhash_rust::const_xxh3::xxh3_64 as const_xxh3;
use xxhash_rust::xxh3::xxh3_64;
const TEST: u64 = const_xxh3(b"TEST");
fn test_input(text: &str) -> bool {
match xxh3_64(text.as_bytes()) {
TEST => true,
_ => false
}
}
assert!(!test_input("tEST"));
assert!(test_input("TEST"));
```
## Features:
By default all features are off.
- `std` - Enables `std::io::Write` trait implementation
- `xxh32` - Enables 32bit algorithm. Suitable for x86 targets
- `const_xxh32` - `const fn` version of `xxh32` algorithm
- `xxh64` - Enables 64 algorithm. Suitable for x86_64 targets
- `const_xxh64` - `const fn` version of `xxh64` algorithm
- `xxh3` - Enables `xxh3` family of algorithms, superior to `xxh32` and `xxh64` in terms of performance.
- `const_xxh3` - `const fn` version of `xxh3` algorithm
## HW acceleration
Similar to reference implementation, crate implements various SIMDs in `xxh3` depending on provided flags.
All checks are performed only at compile time, hence user is encouraged to enable these accelerations (for example via `-C target_cpu=native`)
Used SIMD acceleration:
- SSE2 - widely available, can be safely enabled in 99% of cases. Enabled by default in `x86_64` targets.
- AVX2;
- Neon - Enabled by default on aarch64 targets (most likely)
- Wasm SIMD128 - Has to be enabled via rust flag: `-Ctarget-feature=+simd128`
## Streaming vs One-shot
For performance reasons one-shot version of algorithm does not re-use streaming version.
Unless needed, user is advised to use one-shot version which tends to be more optimal.
## `const fn` version
While `const fn` provides compile time implementation, it does so at performance cost.
Hence you should only use it at _compile_ time.
To guarantee that something is computed at compile time make sure to initialize hash output
as `const` or `static` variable, otherwise it is possible function is executed at runtime, which
would be worse than regular algorithm.
`const fn` is implemented in best possible way while conforming to limitations of Rust `const
fn`, but these limitations are quite strict making any high performance code impossible.
## Version note
- `0.8.*` corresponds to C's `0.8.*`
In order to keep up with original implementation version I'm not planning to bump major/minor until C implementation does so.