Checking remaining bytes and avoid panicing on truncated messages #150
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
IoNotEnoughBytes error essentially indicates truncated messages and there is not benefits of having this extra error type. By design, it also means it will send warnings for truncated messages when attempt to read more than the data source contains.
Bytes::split_to will panic if not enough bytes available. We do not want panics so we do the checking first to make sure enough bytes available. If not enough bytes available, it will send out a TruncatedMsg error. The current iterator will catch the error and skip the remainder of the message.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #150 +/- ##
==========================================
+ Coverage 91.85% 91.87% +0.01%
==========================================
Files 66 66
Lines 8703 8709 +6
==========================================
+ Hits 7994 8001 +7
+ Misses 709 708 -1 ☔ View full report in Codecov by Sentry. |
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.
Highlight
Bytes::split_towill panic if not enough bytes available. We do not want panics so we do the checking first to make sure enough bytes available.If not enough bytes available, it will send out a
TruncatedMsgerror. The current iterator will catch the error and skip the remainder of the message.Breaking change
IoNotEnoughBytes, and useTruncatedMsgwhen not enough bytes available to readThis addresses issue #149.
Other changes
bytescrate version to1.5.0