stream: documentation note for throttle Unpin (#3600)

This commit is contained in:
Matthew James Briggs
2021-03-10 08:39:43 +01:00
committed by GitHub
parent b08b5edb2c
commit 8c5cde9bc3
+2 -1
View File
@@ -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> {