Add Peek API variants for ByteBuffer #3160
Merged
Conversation
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
Motivation: Existing get APIs require passing an explicit index and can be misused, leading to verbose and error-prone code. Adding peek variants that automatically use the current readerIndex improves safety and clarity. Modifications: - Introduced peekBytes(length:), peekString(length:), peekNullTerminatedString(), peekUTF8ValidatedString(length:) and peekDispatchData(length:). - Added tests for each peek API covering normal, empty, repeated, and partial read scenarios. Result: Developers can now use nonmutating peek APIs to inspect ByteBuffer contents without altering the reader index.
glbrntt
approved these changes
Mar 31, 2025
Contributor
glbrntt
left a comment
glbrntt
left a comment
There was a problem hiding this comment.
This looks great, thanks @RaghavRoy145!
Contributor
Author
Thanks for the review! Do let me know if there's get methods that I may have missed. I know there's getData and getSlice for example, but if these are not part of the original plan, I can start working on Multiple Integer instead. |
Contributor
|
|
Contributor
Author
Great! Perhaps its better to create a new PR with the ones I find that are defined outside ByteBuffer-aux. |
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.
Motivation:
Existing get APIs require passing an explicit index and can be misused, leading to verbose and error-prone code. Adding peek variants that automatically use the current readerIndex improves safety and clarity. This aims to address #2034 and #2736, and is a continuation of PR #3157
Modifications:
Result:
Developers can now use nonmutating peek APIs to inspect ByteBuffer contents without altering the reader index.
PS: I have focussed on the ByteBuffer-aux get* implementations, so I'm not sure if I am missing any other important/error-prone get* elsewhere, if so, please point me to them and I'll be happy to add respective peek*'s!