File: README.md

package info (click to toggle)
rust-siphasher 0.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 136 kB
  • sloc: makefile: 2
file content (37 lines) | stat: -rw-r--r-- 800 bytes parent folder | download | duplicates (3)
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
SipHash implementation for Rust
===============================

SipHash was recently removed from rust-core.

This crate brings `SipHasher`, `SipHasher13` and `SipHash24` back.
It is based on the original implementation from rust-core and exposes the
same API.

In addition, it can return 128-bit tags.

The `sip` module implements the standard 64-bit mode, whereas the `sip128`
module implements the 128-bit mode.

Usage
-----
In `Cargo.toml`:

```toml
[dependencies]
siphasher = "~0.2"
```

64-bit mode:
```rust
extern crate siphasher;

use siphasher::sip::{SipHasher, SipHasher13, SipHasher24};
```

128-bit mode:
```rust
use siphasher::sip128::{Hasher128, Siphasher, SipHasher13, SipHasher24};
```

[API documentation](https://docs.rs/siphasher/)
-----------------------------------------------