fix: override size_hint for BitIterator to return the exact remaining size
#6495
+29
−0
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
mbrobbel
approved these changes
Oct 2, 2024
alamb
approved these changes
Oct 2, 2024
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.
Which issue does this PR close?
Closes #6480
Rationale for this change
The
BitIteratorimplementation was missing a propersize_hintmethod, which caused it to panic when used in conjunction withExactSizeIterator. TheExactSizeIteratortrait requires thatsize_hint()always return a precise number of elements, and failing to do so caused a mismatch in the expected and actual sizes, leading to an assertion failure.What changes are included in this PR?
This PR introduces a fix by overriding the
size_hint()method inBitIteratorto return the correct remaining number of bits, ensuring compatibility withExactSizeIteratorand preventing panics.Are there any user-facing changes?
No breaking changes to public APIs.