summaryrefslogtreecommitdiff
path: root/src/stream_ext/throttle.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/stream_ext/throttle.rs')
-rw-r--r--src/stream_ext/throttle.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/stream_ext/throttle.rs b/src/stream_ext/throttle.rs
index 99f3e0e..f36c66a 100644
--- a/src/stream_ext/throttle.rs
+++ b/src/stream_ext/throttle.rs
@@ -23,7 +23,8 @@ where
}
pin_project! {
- /// Stream for the [`throttle`](throttle) function.
+ /// Stream for the [`throttle`](throttle) function. This object is `!Unpin`. If you need it to
+ /// implement `Unpin` you can pin your throttle like this: `Box::pin(your_throttle)`.
#[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct Throttle<T> {