Skip to content

Commit 1340b16

Browse files
jongiddytaiki-e
authored andcommitted
Remove incorrect error behavior from ready_chunks docs (#2687)
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.
1 parent 71f7b78 commit 1340b16

File tree

1 file changed

+1
-2
lines changed
  • futures-util/src/stream/stream

1 file changed

+1
-2
lines changed

futures-util/src/stream/stream/mod.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -1513,8 +1513,7 @@ pub trait StreamExt: Stream {
15131513
/// be immediately returned.
15141514
///
15151515
/// If the underlying stream ended and only a partial vector was created,
1516-
/// it'll be returned. Additionally if an error happens from the underlying
1517-
/// stream then the currently buffered items will be yielded.
1516+
/// it will be returned.
15181517
///
15191518
/// This method is only available when the `std` or `alloc` feature of this
15201519
/// library is activated, and it is activated by default.

0 commit comments

Comments
 (0)