Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning about LZ4FastCompressor and LZ4HCCompressor #45

Merged
merged 1 commit into from
Feb 2, 2024
Merged

Add warning about LZ4FastCompressor and LZ4HCCompressor #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Codecs for the standard LZ4 and LZ4_HC formats are also provided as `LZ4FastComp
These codecs follow the [LZ4 streaming examples](https://github.com/lz4/lz4/tree/master/examples),
breaking the data into blocks and prepending each compressed block with a size.
Data compressed with these codecs can be decompressed with `LZ4SafeDecompressor`.
> [!CAUTION]
> `LZ4FastCompressor` and `LZ4HCCompressor` output is not compatible with lz4frame and is platform dependent.


Non-streaming functions are included via `lz4_compress`, `lz4_hc_compress`, and `lz4_decompress`.
These should work with most other standard lz4 implementations.
Expand Down
Loading