Skip to content

Commit

Permalink
Remove incorrect error behavior from ready_chunks docs (#2687)
Browse files Browse the repository at this point in the history
Unlike `TryStream::try_chunks`, which has similar documentation and can
handle `Some(Err(_))` specially, `Stream::ready_chunks` does not and
cannot know whether the stream item represents an error condition, and
does not include any code to return early on an error.
  • Loading branch information
jongiddy authored and taiki-e committed Jan 30, 2023
1 parent 71f7b78 commit 1340b16
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions futures-util/src/stream/stream/mod.rs
Expand Up @@ -1513,8 +1513,7 @@ pub trait StreamExt: Stream {
/// be immediately returned.
///
/// If the underlying stream ended and only a partial vector was created,
/// it'll be returned. Additionally if an error happens from the underlying
/// stream then the currently buffered items will be yielded.
/// it will be returned.
///
/// This method is only available when the `std` or `alloc` feature of this
/// library is activated, and it is activated by default.
Expand Down

0 comments on commit 1340b16

Please sign in to comment.