mirror/async-std
2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-01-30 17:25:32 +00:00
Code Issues Releases Wiki Activity

Wrap around throttle comment

Browse source 
Co-Authored-By: Yoshua Wuyts <yoshuawuyts+github@gmail.com>
This commit is contained in:
Wouter Geraedts 2019-11-12 14:34:31 +01:00 committed by GitHub
parent ef958f0408
commit 7c7386735e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/stream/stream/throttle.rs
View file

@ -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> {