Project

lzfse

0.0
The project is in a healthy, maintained state
lzfsewoodruffw/lzfse.rbHomepageDocumentationSource CodeBug TrackerWiki
lzfse is a Ruby gem containing bindings for Apple's LZFSE and LZVN compression algorithms. It binds Apple's reference implementation and exposes compression and decompression APIs for both LZFSE and LZVN.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
6,816
Stars
6
Forks
0
Watchers
3
 Releases
Current version
0.0.2
Total releases
5
First release
2021-05-31
Latest release
2023-09-14
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
9
Pull Request Acceptance Rate
90%
 Development
Primary Language
C
Licenses
MIT
Average date of last 50 commits
2022-05-26
Reverse Dependencies
1

 Dependencies
 Project Readme

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.