2018-11-02 05:20:45 +00:00
|
|
|
# Snappy
|
2019-08-24 16:35:53 +00:00
|
|
|
[](https://travis-ci.org/status-im/nim-snappy)
|
|
|
|
|
[](https://ci.appveyor.com/project/nimbus/nim-snappy/branch/master)
|
2018-11-02 05:20:45 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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]
|
2018-11-02 13:36:21 +00:00
|
|
|
* template compress --- an alias to encode
|
|
|
|
|
* template uncompress --- an alias to decode
|
2018-11-02 05:20:45 +00:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
```Nim
|
|
|
|
|
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
|
