JenkHash 0.2.0

Bob Jenkins hash functions for Rust with a digest-compatible API.
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

## JenkHash

A collection of Bob Jenkins hash functions for Rust with a unified API. The crate targets `no_std`, provides a custom [`Hasher`](src/hash.rs) trait for incremental hashing, and ships reference implementations of several classic non-cryptographic hashes.

### Available Hash Functions
- `OneAtATime` — simple, fast 32-bit hash for hash tables
- `Lookup2` — original Jenkins hash (32-bit)
- `Lookup3` — improved Jenkins hash with stronger avalanche (32-bit)
- `Spooky` — high-performance hash optimized for 64-bit CPUs (variable output sizes)

### Installation
Add the crate to your `Cargo.toml`:
```toml
[dependencies]
jenkhash = "0.1"
```

### Usage
```rust
use jenkhash::{Hasher, OneAtATime};

let mut hasher = OneAtATime::new();
hasher.write(b"hello");
hasher.write(b" world");
let hash = hasher.finalize();
assert_eq!(hash, 1045060183);
```

### Notes
- Use these hashes for non-cryptographic purposes (e.g., hash tables, sharding, deduplication).
- Keep input sizes reasonable; these algorithms are not designed as secure cryptographic hashes.

[//]: # (- Prefer `Spooky` for speed on 64-bit platforms; use `OneAtATime` or `Lookup3` when a 32-bit output is sufficient.)

### Development
- Tests: `cargo test`
- Lint (Clippy): `cargo clippy --all-targets --all-features`