It's not an error to pass a buffer larger than the decompressed data. #37
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
The reference implementation specifies that the size of the destination buffer is presumed to be an upper bound. Passing too large a buffer is not an error. Overwriting the buffer is handled as an error internally.
Codecov Report
@@ Coverage Diff @@
## main #37 +/- ##
==========================================
+ Coverage 91.07% 91.98% +0.90%
==========================================
Files 11 11
Lines 2197 2171 -26
==========================================
- Hits 2001 1997 -4
+ Misses 196 174 -22
Continue to review full report at Codecov.
|
PSeitz
reviewed
Feb 7, 2022
| actual: decomp_len, | ||
| }); | ||
| } | ||
| vec.truncate(decomp_len); |
There was a problem hiding this comment.
this check also included if the passed buffer was smaller
|
Thanks, I just realized that in that step only sizes that are larger are checked It's implemented in this PR: #78 |
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.
As per the reference implementation of LZ4_decompress_safe:
I think this mistake originates from a misleading comment on lzzzz which seems to indicate that the buffer must be exactly the size of the decompressed data. However neither those bindings nor the underlying library make that assertion.
This PR is a breaking change since I removed the now unused
UncompressedSizeDiffersvariant from theDecompressErrorenum.