SnappyEx (snappyex v0.1.0)
View SourcePublic API for raw Snappy blocks.
compress/1 and decompress/1 work with the standard raw Snappy block
format: an uncompressed-size varint followed by literal and copy commands.
compress_framed/1 and decompress_framed/1 work with the Snappy framed
stream format.
Summary
Functions
Compresses a binary into the raw Snappy block format.
Compresses a binary into the Snappy framed stream format.
Decompresses a raw Snappy block.
Decompresses a raw Snappy block, raising ArgumentError for malformed input.
Decompresses a Snappy framed stream.
Decompresses a Snappy framed stream, raising ArgumentError for malformed input.
Types
Functions
Compresses a binary into the raw Snappy block format.
Compresses a binary into the Snappy framed stream format.
@spec decompress(binary()) :: {:ok, binary()} | {:error, decompress_error()}
Decompresses a raw Snappy block.
Returns {:ok, binary} on success or {:error, reason} for malformed input.
Decompresses a raw Snappy block, raising ArgumentError for malformed input.
@spec decompress_framed(binary()) :: {:ok, binary()} | {:error, framed_decompress_error()}
Decompresses a Snappy framed stream.
Returns {:ok, binary} on success or {:error, reason} for malformed input.
Decompresses a Snappy framed stream, raising ArgumentError for malformed input.