summaryrefslogtreecommitdiff
path: root/src/stream_ext/try_next.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/stream_ext/try_next.rs')
-rw-r--r--src/stream_ext/try_next.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/stream_ext/try_next.rs b/src/stream_ext/try_next.rs
index af27d87..93aa3bc 100644
--- a/src/stream_ext/try_next.rs
+++ b/src/stream_ext/try_next.rs
@@ -9,6 +9,12 @@ use pin_project_lite::pin_project;
pin_project! {
/// Future for the [`try_next`](super::StreamExt::try_next) method.
+ ///
+ /// # Cancel safety
+ ///
+ /// This method is cancel safe. It only
+ /// holds onto a reference to the underlying stream,
+ /// so dropping it will never lose a value.
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct TryNext<'a, St: ?Sized> {