third_party/rust/siphasher/README.md
author Oriol Brufau <oriol-bugzilla@hotmail.com>
Wed, 31 Oct 2018 16:15:54 +0000
changeset 500988 8a28169fa91dbde370d47bd91bc1b0c91f89cacf
parent 391321 b92f6949d70442e06c66e2a2d120a81984c8289b
permissions -rw-r--r--
Bug 1499693 - Choose correct add-on icon size in about:addons. r=mstriemer,aswan, a=RyanVM Differential Revision: https://phabricator.services.mozilla.com/D9347

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 experimental 128-bit mode.

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

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

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/)
-----------------------------------------------