Feature/dictionary standardized - Githubissues

SpringMT / zstd-ruby

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

https://github.com/facebook/zstd

BSD 3-Clause "New" or "Revised" License

69 stars 16 forks source link

Feature/dictionary standardized #77

Closed SpringMT closed 7 months ago

SpringMT commented 7 months ago

Feature

Zstd.compress supports :level and :dict keyword args
Zstd.decompress supports :dict keyward args
Zstd::StreamingCompress.new supports :level and :dict keyword args
Zstd::StreamingDecompress.new supports :dict keyword args

Breaking Changes

Zstd.compress uses ZSTD_compressStream2 instead of ZSTD_compress
Zstd.decompress uses ZSTD_decompressDCtx instead of ZSTD_decompress

Deprecation

Zstd.compress_using_dict adds deprecation warning
- use Zstd.compress with :dict keyword args
Zstd.decompress_using_dict adds deprecation warning
- use Zstd.decompress with :dict keyword args
Zstd.compress with level args add deprecation warning
- use Zstd.compress with :level keyword args
Zstd::StreamingCompress.new with level args add deprecation warning
- use Zstd::StreamingCompress.new with :level keyword args

Related to https://github.com/SpringMT/zstd-ruby/issues/61