2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-02-07 05:05:32 +00:00

Merge pull request #402 from async-rs/fuse-docs

update Stream::fuse docs
This commit is contained in:
Yoshua Wuyts 2019-10-29 10:49:43 +01:00 committed by GitHub
commit 997e811c58
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 5 deletions

View file

@ -6,8 +6,7 @@ use crate::stream::Stream;
use crate::task::{Context, Poll};
pin_project! {
/// A `Stream` that is permanently closed once a single call to `poll` results in
/// `Poll::Ready(None)`, returning `Poll::Ready(None)` for all future calls to `poll`.
/// A stream that yields `None` forever after the underlying stream yields `None` once.
///
/// This `struct` is created by the [`fuse`] method on [`Stream`]. See its
/// documentation for more.

View file

@ -505,9 +505,11 @@ extension_trait! {
}
#[doc = r#"
Transforms this `Stream` into a "fused" `Stream` such that after the first time
`poll` returns `Poll::Ready(None)`, all future calls to `poll` will also return
`Poll::Ready(None)`.
Creates a stream which ends after the first `None`.
After a stream returns `None`, future calls may or may not yield `Some(T)` again.
`fuse()` adapts an iterator, ensuring that after a `None` is given, it will always
return `None` forever.
# Examples