Add warning about LZ4FastCompressor and LZ4HCCompressor
#45
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add the warning from https://github.com/lz4/lz4/blob/dev/examples/blockStreaming_doubleBuffer.md
The format used by these compressors is platform-specific, so they should never be used to archive data.
As noted in lz4/lz4#1318 (comment) and https://github.com/lz4/lz4/blob/dev/examples/blockStreaming_doubleBuffer.md this is a very advanced API, intended for systems with limited memory, and I'm not sure we should support these in this package.