nimsnappyc

Wrapper for the Snappy-C compression library

Readme

Build Status Build status

NimSnappyC

NimSnappyC provides a Snappy compression/decompression for Nim through wrapping to snappy-c.

GitHub Repo

Installation

Add this to your application's .nimble file:

requires "nimsnappyc"

or to install globally run:

nimble install nimsnappyc

Usage

import nimsnappyc

# Compress a string:
let data = "0123456789abcdef"
let compressed = snappyCompress(data)

# Get the uncompressed length of compressed data:
let uncompressedLen = snappyUncompressedLength(compressed)

# Uncompress a compressed data:
let uncompressed = snappyUncompress(compressed)

Raises the SnappyError exception on errors.

Contributing

  1. Fork it (https://github.com/NimCompression/nimsnappyc/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

MIT

Authors: NimCompression

Snappy-C License

BSD 3-Clause License

Author: Andi Kleen

Need help? Read Nimble
No tagged versions available
License: MIT

Project website Hosted docs