Skip to content

docs: notes on poll_frame return values #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2025
Merged

docs: notes on poll_frame return values #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0829679
docs: notes on poll_frame return values
cratelyn Jan 10, 2025
eeafd33
review: update stale "data buffer" terminology
cratelyn Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion http-body/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,22 @@ pub trait Body {
type Error;

#[allow(clippy::type_complexity)]
/// Attempt to pull out the next data buffer of this stream.
/// Attempt to pull out the next frame of this stream.
///
/// # Return value
///
/// This function returns:
///
/// - [`Poll::Pending`] if the next frame is not ready yet.
/// - [`Poll::Ready(Some(Ok(frame)))`] when the next frame is available.
/// - [`Poll::Ready(Some(Err(error)))`] when an error has been reached.
/// - [`Poll::Ready(None)`] means that all of the frames in this stream have been returned, and
/// that the end of the stream has been reached.
///
/// If [`Poll::Ready(Some(Err(error)))`] is returned, this body should be discarded.
///
/// Once the end of the stream is reached, implementations should continue to return
/// [`Poll::Ready(None)`].
fn poll_frame(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
Expand Down