docs: notes on poll_frame return values

Signed-off-by: katelyn martin <[email protected]>

Author: cratelyn

http-body/src/lib.rs

@@ -44,6 +44,21 @@ pub trait Body {
 
     #[allow(clippy::type_complexity)]
     /// Attempt to pull out the next data buffer 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<'_>,