Project

zstd-ruby

0.04
A long-lived project that still receives updates
Ruby binding for zstd(Zstandard - Fast real-time compression algorithm). See https://github.com/facebook/zstd
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 13.0
~> 3.0
 Project Readme

Gem Version Build Status

zstd-ruby

Ruby binding for zstd(Zstandard - Fast real-time compression algorithm)

See https://github.com/facebook/zstd

Fork from https://github.com/jarredholman/ruby-zstd.

Zstd version

v1.5.1 (https://github.com/facebook/zstd/tree/v1.5.1)

Installation

Add this line to your application's Gemfile:

gem 'zstd-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zstd-ruby

Usage

require 'zstd-ruby'

compression

compressed_data = Zstd.compress(data)
compressed_data = Zstd.compress(data, complession_level) # default compression_level is 0

decompression

data = Zstd.decompress(compressed_data)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/SpringMT/zstd_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the BSD-3-Clause License.