**************
MurmurHash3.rs
**************

.. image:: https://travis-ci.org/mhallin/murmurhash3-rs.svg?branch=master
   :target: https://travis-ci.org/mhallin/murmurhash3-rs

A rust implementation of the MurmurHash3_. Both 32 bit and 128 bit versions are included. The 128
bit version is implemented with 64 bit datatypes, making it most suitable for x86_64 or other 64 bit
architectures.

----

Usage
=====

In your ``Cargo.toml``:

.. code:: toml

    [dependencies]
    murmurhash3 = "*"

Then you can start to use either ``murmurhash3_x86_32`` or ``murmurhash3_x64_128``:

.. code:: rust

    use murmurhash3::murmurhash3_x64_128;

    fn hash_value() {
        let data = "test data";
        let seed = 48221234;

        let hash = murmurhash3_x64_128(data.as_bytes(), seed);
    }

Unfortunately, there is a bug in the ``HashState`` library implementation which prevents
implementation of new ``Hasher`` implementations for use in for example ``HashMap``. Additionally,
only the 32 bit hasher can be used there since ``HashMap`` uses a 64 bit hash internally.

Tests
=====

.. code::

    cargo test

Runs all tests with optimization level 3 in order to weed out potential problems with the optimizer.

.. _MurmurHash3: https://code.google.com/p/smhasher/wiki/MurmurHash3