Clarification about Response.readEntity(XXX) #1166
Open
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
Signed-off-by: Nicolas NESMON (NicoNes) <[email protected]>
spericas
reviewed
Aug 23, 2023
| * stream are read and stored in a local buffer. The original entity input stream is consumed and automatically closed | ||
| * as part of the operation and the method returns {@code true}. | ||
| * In case the message entity is backed by an input stream not consumed at all, all the bytes of that input | ||
| * stream are read (i.e until <code>inputStream.read() == -1</code>) and stored in a local buffer. That input |
There was a problem hiding this comment.
Overall, this looks like a step in the right direction. However, I think the phrase "not consumed at all" is a bit vague. If we mean, "not a single byte from the input stream has been read", we should be more explicit IMO. This phrase is used multiple times.
There was a problem hiding this comment.
@NicoNes Could you review and respond to the comment?
There was a problem hiding this comment.
@spericas I agree we can be more exeplicit.
What about saying " In case the message entity is backed by an input stream of which no byte has been read" ?
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.
This PR replaces this one #1001.
Exact same content but targeting branch
release-4.0-- Nicolas