nim-snappy/README.md

Snappy

Nim implementation of Snappy compression algorithm

Currently, this implementation only support block compression and no stream compression support at all.

API

• proc encode*(src: openArray[byte]): seq[byte]
• proc decode*(src: openArray[byte]): seq[byte]
• template compress --- an alias to encode
• template uncompress --- an alias to decode

Examples

import snappy
var source = readFile("readme.md")
var encoded = snappy.encode(toOpenArrayByte(source, 0, source.len-1))
var decoded = snappy.decode(encoded)
assert equalMem(decoded[0].addr, source[0].addr, source.len)

Installation via nimble

nimble install snappy