Snappy.jl is a Julia wrapper for the snappy library - a compression/decompression library focusing on speed.

The Snappy module exports only two functions:

• compress(input::Vector{Uint8}) -> compressed::Vector{Uint8}
• uncompress(input::Vector{Uint8}) -> uncompressed::Vector{Uint8}.

These functions are self-explanatory and works as such (hence, always satisfies uncompress(compress(input)) == input for any input).

If you digg into the module, you will find the following lower-level functions:

• snappy_compress(input::Vector{Uint8}, compressed::Vector{Uint8}) -> (length, status)
• snappy_uncompress(compressed::Vector{Uint8}, uncompressed::Vector{Uint8}) -> (length, status)
• snappy_max_compressed_length(source_length::Uint) -> length
• snappy_uncompressed_length(compressed::Vector{Uint8}) -> (length, status)
• snappy_validate_compressed_buffer(compressed::Vector{Uint8}) -> status.

These functions have one-to-one correspondance to the C-APIs and are very thin wrappers of them, so you can consult the "snappy-c.h" header file for the documentation. Moreover, even though these functions are not exported by default, you can assume that they are stable as long as the original C-APIs are stable.

At the current moment, the snappy library itself should be installed in advance except Mac OS X (if you are using Homebrew) and should be located where BinDeps.jl can find it automatically.