KAFKA-19877: Clarify ByteBuffer position and limit expectations for Deserializer #21371
+5
−0
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
The Deserializer interface currently does not clearly specify how a
ByteBuffer'spositionandlimitshould be treated during and after deserialization.This ambiguity can lead to inconsistent implementations and incorrect assumptions
by callers.
Changes
Deserializer#deserialize(String, Headers, ByteBuffer)to state that implementations should read from the buffer’s current position,
may advance the position by the number of bytes consumed, and must not modify
the buffer limit.
after deserialization.
Notes
This change is documentation-only and does not modify runtime behavior.