#async #futures #stream #throttle

stream_throttle

Provides a Stream combinator, to limit the rate at which items are produced

6 releases (breaking)

0.5.1 Sep 5, 2023
0.4.0 Apr 7, 2021
0.3.1 Feb 9, 2020
0.2.1 Nov 11, 2018
0.1.1 May 31, 2018

#142 in Asynchronous

Download history 4550/week @ 2023-11-02 4401/week @ 2023-11-09 6114/week @ 2023-11-16 5539/week @ 2023-11-23 5240/week @ 2023-11-30 6223/week @ 2023-12-07 4747/week @ 2023-12-14 2024/week @ 2023-12-21 1964/week @ 2023-12-28 4299/week @ 2024-01-04 4979/week @ 2024-01-11 6344/week @ 2024-01-18 5896/week @ 2024-01-25 4311/week @ 2024-02-01 5316/week @ 2024-02-08 4866/week @ 2024-02-15

21,521 downloads per month
Used in 2 crates

MIT license

14KB
205 lines

stream_throttle

Provides a Rust Stream combinator, to limit the rate at which items are produced.

Crates.io API Documentation

Key Features

  • Throttling is implemented via poll(), and not via any sort of buffering.
  • The throttling behaviour can be applied to both Stream's and Future's.
  • Multiple streams/futures can be throttled together as a group.
  • Feature flags to use various timer implementations.

Feature Flags

  • timer-tokio: Uses the tokio::time::delay_for() timer.
  • timer-futures-timer: Uses the futures_timer::Delay timer.

If you don't use the default timer (tokio), make sure to set default-features = false in your Cargo.toml, when you add stream_throttle as a dependency.

Example throttling of Stream

// allow no more than 5 items every 1 second
let rate = ThrottleRate::new(5, Duration::new(1, 0));
let pool = ThrottlePool::new(rate);

let work = stream::repeat(())
  .throttle(pool)
  .then(|_| futures::future::ready("do something else"))
  .for_each(|_| futures::future::ready(()));
  
work.await;

Example throttling of Future

let rate = ThrottleRate::new(5, Duration::new(1, 0));
let pool = ThrottlePool::new(rate);

let work = pool.queue()
  .then(|_| futures::future::ready("do something else"));
  
work.await;

Dependencies

~0.7–2MB
~36K SLoC