Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document cancel-safety of StreamExt::next #2896

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document cancel-safety of StreamExt::next #2896

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions futures-util/src/stream/stream/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,12 @@ pub trait StreamExt: Stream {
/// pinning it to the stack using the `pin_mut!` macro from the `pin_utils`
/// crate.
///
/// # Cancel safety
///
/// The returned future only holds a reference to the underlying stream, and
/// so is cancel safe (assuming the stream is also cancel-safe). If it is
/// dropped before it resolves, no item from the stream will be dropped.
///
/// # Examples
///
/// ```
Expand Down