Wrap around throttle comment

Co-Authored-By: Yoshua Wuyts <yoshuawuyts+github@gmail.com>
new-scheduler
Wouter Geraedts 5 years ago committed by GitHub
parent ef958f0408
commit 7c7386735e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -9,7 +9,13 @@ use crate::stream::Stream;
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
pin_project! { pin_project! {
/// A stream that only yields one element once every `duration`, and applies backpressure. Does not drop any elements. /// A stream that only yields one element once every `duration`.
///
/// This `struct` is created by the [`throttle`] method on [`Stream`]. See its
/// documentation for more.
///
/// [`throttle`]: trait.Stream.html#method.throttle
/// [`Stream`]: trait.Stream.html
#[doc(hidden)] #[doc(hidden)]
#[allow(missing_debug_implementations)] #[allow(missing_debug_implementations)]
pub struct Throttle<S> { pub struct Throttle<S> {

Loading…
Cancel
Save