xxhash-0.0.1: A Haskell implementation of the xxHash algorithm

Portabilityportable
Stabilityexperimental
Maintainerpingu@anchor.net.au
Safe HaskellNone

Data.Digest.XXHash

Contents

Description

This module provides a pure implementation of the xxHash algorithm.

This implementation is almost as fast as the C version, which is avaliable as c_xxHash'.

Criterion benchmarks are avaliable via cabal bench.

More information on the algorithm may be found here: https://code.google.com/p/xxhash/

Synopsis

Types

Haskell implementation

xxHash :: ByteString -> XXHashSource

Hash a lazy ByteString.

xxHash' :: ByteString -> XXHashSource

Hash a strict ByteString.

C bindings

c_xxHash' :: ByteString -> XXHashSource

Hash a strict ByteString using the C implementation, the length of the ByteString should be limited to 2^31-1 or the results will be invalid.

This is mostly used internally for benchmarking and verification. It's use in production is not recommended.