Skip to content

Commit

Permalink
Add warning about LZ4FastCompressor and LZ4HCCompressor (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
nhz2 authored Feb 2, 2024
1 parent dacd0dd commit 0536b47
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
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

0 comments on commit 0536b47

Please sign in to comment.