Skip to content

Commit 7c73867

Browse files
Wrap around throttle comment
Co-Authored-By: Yoshua Wuyts <[email protected]>
1 parent ef958f0 commit 7c73867

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/stream/stream/throttle.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ use crate::stream::Stream;
99
use crate::task::{Context, Poll};
1010

1111
pin_project! {
12-
/// A stream that only yields one element once every `duration`, and applies backpressure. Does not drop any elements.
12+
/// A stream that only yields one element once every `duration`.
13+
///
14+
/// This `struct` is created by the [`throttle`] method on [`Stream`]. See its
15+
/// documentation for more.
16+
///
17+
/// [`throttle`]: trait.Stream.html#method.throttle
18+
/// [`Stream`]: trait.Stream.html
1319
#[doc(hidden)]
1420
#[allow(missing_debug_implementations)]
1521
pub struct Throttle<S> {

0 commit comments

Comments
 (0)