diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ad28d8..bf3c7f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,28 @@ - Docs: add decompress block example +### Fixes +- Handle empty input in Frame Format [#120](https://github.com/PSeitz/lz4_flex/pull/120) +``` +Empty input was ignored previously and didn't write anything. Now an empty Frame is written. This improves compatibility with the reference implementation and some corner cases. +``` + +- Fix: Small dict leads to panic [#133](https://github.com/PSeitz/lz4_flex/pull/133) +``` +compress_into_with_dict panicked when the dict passed was smaller than 4 bytes. A match has the minimum length of 4 bytes, smaller dicts will be ignored now. +``` + ### Features +- [**breaking**] invert checked-decode to unchecked-decode [#134](https://github.com/PSeitz/lz4_flex/pull/134) +``` +invert `checked-decode` feature flag to `unchecked-decode` +Previously setting `default-features=false` removed the bounds checks from the +`checked-decode` feature flag. `unchecked-decode` inverts this, so it will needs to be +deliberately deactivated. + +To migrate, just remove the `checked-decode` feature flag. +``` - Allow to pass buffer larger than size [#78](https://github.com/PSeitz/lz4_flex/pull/78) ``` This removes an unnecessary check in the decompression, when the passed buffer is too big. @@ -30,10 +50,6 @@ let info = FrameInfo::new() .block_size(BlockSize::Max1MB) .content_checksum(true); ``` -- Handle empty input [#120](https://github.com/PSeitz/lz4_flex/pull/120) -``` -Empty input was ignored previously and didn't write anything. Now an empty Frame is written. This improves compatibility with the reference implementation and some corner cases. -``` ### Performance - Perf: Faster Decompression [#113](https://github.com/PSeitz/lz4_flex/pull/113) [#112](https://github.com/PSeitz/lz4_flex/pull/112) diff --git a/README.md b/README.md index 1ee62c5..ae527c6 100644 --- a/README.md +++ b/README.md @@ -133,3 +133,12 @@ This fuzz target asserts compression with cpp and decompression with lz4_flex re ## TODO - High compression +## Migrate from v0.10 to v0.11 +0.11 inverts `checked-decode` feature flag to `unchecked-decode`. +Previously setting `default-features=false` removed the bounds checks from the +`checked-decode` feature flag. `unchecked-decode` inverts this, so it will needs to be +deliberately deactivated. + +To migrate, just remove the `checked-decode` feature flag if you use it. + +