Documentation of which zstd features are unsupported?

valyala / gozstd

go wrapper for zstd

MIT License

434 stars 63 forks source link

Documentation of which zstd features are unsupported? #3

Closed carbocation closed 6 years ago

carbocation commented 6 years ago

In some comments on social media, you mentioned that some features (block, parallel) are not supported. Would be great to have a quick blurb about which features are not supported in the README. Thanks!

valyala commented 6 years ago

It is easier to enumerate supported features than unsupported features, since upstream zstd is constantly evolving and new features may appear anytime. Supported features are:

Block / stream compression / decompression with all the supported compression levels and with dictionary support
Dictionary building from a sample set. The created dictionary may be saved to persistent storage / transfered over the network
Dictiinary loading for compression / decompression

carbocation commented 6 years ago

That's a good summary. Could throw that in the README and append to that something like, "Since the upstream zstd is constantly evolving, several other features are not yet supported, but pull requests are welcome."

valyala commented 6 years ago

Done