README.md
1SipHash implementation for Rust
2===============================
3
4SipHash was recently removed from rust-core.
5
6This crate brings `SipHasher`, `SipHasher13` and `SipHash24` back.
7It is based on the original implementation from rust-core and exposes the
8same API.
9
10In addition, it can return 128-bit tags.
11
12The `sip` module implements the standard 64-bit mode, whereas the `sip128`
13module implements the experimental 128-bit mode.
14
15Usage
16-----
17In `Cargo.toml`:
18
19```toml
20[dependencies]
21siphasher = "~0.1"
22```
23
2464-bit mode:
25```rust
26extern crate siphasher;
27
28use siphasher::sip::{SipHasher, SipHasher13, SipHasher24};
29```
30
31128-bit mode:
32```rust
33use siphasher::sip128::{Hasher128, Siphasher, SipHasher13, SipHasher24};
34```
35
36[API documentation](https://docs.rs/siphasher/)
37-----------------------------------------------
38