/lzfse.rb

Ruby bindings for Apple's LZFSE, including LZVN

Primary LanguageCMIT LicenseMIT

lzfse.rb

CI Gem Version

Ruby bindings for Apple's reference implementation of LZFSE.

Bindings are also provided for the internal LZVN APIs.

Usage

You'll need the gem:

gem install lzfse

Then, use the four public APIs:

require "lzfse"

# LZFSE
compressed = LZFSE.lzfse_compress "please compress this string"
LZFSE.lzfse_decompress compressed

# LZVN
compressed = LZFSE.lzvn_compress "please also compress this string!"
LZFSE.lzvn_compress compressed

Each API takes a single string and returns a string.

License

lzfse.rb is licensed under the MIT license.

Apple's reference implementation of LZFSE is licensed under the 3-clause BSD license.