Skip to content

Commit fd6bd8b

Browse files
committed
Document intermittent flushing by FeedAll
1 parent c06cebf commit fd6bd8b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

futures-util/src/sink/mod.rs

+2
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,8 @@ pub trait SinkExt<Item>: Sink<Item> {
264264
/// This future will drive the stream to keep producing items until it is
265265
/// exhausted, sending each item to the sink. It will complete once the
266266
/// stream is exhausted and the sink has received all items.
267+
/// While the stream is not ready to yield the next item, this future will
268+
/// drive the sink to flush any pending items.
267269
/// Note that the sink is **not** closed.
268270
///
269271
/// Unlike `send_all`, the returned future does not fully flush the sink

0 commit comments

Comments
 (0)