toByteArray should return a copy not a reference - #3729
Merged
Fokko merged 3 commits intoAug 31, 2026
Conversation
dossett
commented
Aug 17, 2026
| * Zero-copy override: returns the backing array directly when fully used, | ||
| * skipping the base-class BAOS allocation + copy on every decompressor call. | ||
| * Returning the mutable array is safe — the base class already exposes a | ||
| * mutable {@code BAOS.getBuf()}. |
Contributor
Author
There was a problem hiding this comment.
I think Returning the mutable array is safe is the key. The array was mutable before, but it was a mutable copy of the original array.
Contributor
There was a problem hiding this comment.
Should we revert the whole toByteArray method? This effectively reverts the part in:
It is also deprecated
Fokko
approved these changes
Aug 31, 2026
Fokko
left a comment
Fokko
left a comment
Contributor
There was a problem hiding this comment.
Thanks for fixing this issue and removing the override, less is more 👍
Fokko
pushed a commit
that referenced
this pull request
Aug 31, 2026
* BytesInput.copy(BytesInput) should return a copy * make tests clearer * Remove unsafe BytesInput toByteArray override
Fokko
changed the title
toByteArray should return a copy not a reference
This file contains hidden or 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
2 participants
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.
#3565 introduced several optimizations, but I think it also introduced an issue that PR seeks to address. Basically
BytesInput.copy(BytesInput)has a public contract to return a copy, but a change toBytesInput.toByteArray()led to returning a reference in some cases. In addition to breaking the public contract, this can lead to data corruption.See also #3717