docs: notes on poll_frame return values #144
Merged
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: katelyn martin <me+cratelyn@katelyn.world>
cratelyn
force-pushed
the
poll-frame-docs
branch
from
b732594 to
0829679
Compare
seanmonstar
approved these changes
Jan 31, 2025
http-body/src/lib.rs
Outdated
| @@ -44,6 +44,21 @@ pub trait Body { | |||
|
|
|||
| #[allow(clippy::type_complexity)] | |||
| /// Attempt to pull out the next data buffer of this stream. | |||
There was a problem hiding this comment.
I know this isn't part of the PR, but I just noticed this is old. I think this is when the functions were separate, poll_data and poll_trailers. It should mention just the "next frame" instead of data specifically.
If you want to fix it up :)
There was a problem hiding this comment.
yes! i didn't want to change it unprompted, but i can do that.
Signed-off-by: katelyn martin <me+cratelyn@katelyn.world>
seanmonstar
approved these changes
Jan 31, 2025
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 commit introduces some additional documentation for
Body::poll_frame(..).this adds some explicit information about what different return values indicate, and how callers are expected to respond to particular outcomes. these docs are modeled after the equivalent sections in the documentation of
StreamandFuture.