stream: document that throttle operates on ms granularity (#5101)

tokio-rs · Oct 14, 2022 · 1e43759 · 1e43759
1 parent bf5eed8
commit 1e43759
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/tokio-stream/src/stream_ext.rs b/tokio-stream/src/stream_ext.rs
@@ -982,6 +982,8 @@ pub trait StreamExt: Stream {
 
     /// Slows down a stream by enforcing a delay between items.
     ///
+    /// The underlying timer behind this utility has a granularity of one millisecond.
+    ///
     /// # Example
     ///
     /// Create a throttled stream.