27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
|
# Snappy
|
||
|
|
[](https://travis-ci.org/jangko/snappy)
|
||
|
|
[](https://ci.appveyor.com/project/jangko/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]
|
||
|
|
|
||
|
|
## 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
|