Skip to content

Commit 838f9ef

Browse files
authored
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 c420551 commit 838f9ef

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1682,8 +1682,7 @@ pub trait StreamExt: Stream {
16821682
/// be immediately returned.
16831683
///
16841684
/// If the underlying stream ended and only a partial vector was created,
1685-
/// it'll be returned. Additionally if an error happens from the underlying
1686-
/// stream then the currently buffered items will be yielded.
1685+
/// it will be returned.
16871686
///
16881687
/// This method is only available when the `std` or `alloc` feature of this
16891688
/// library is activated, and it is activated by default.

0 commit comments

Comments
 (0)