stream_throttle 0.1.1

Provides a Stream combinator, to limit the rate at which items are produced.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# stream_throttle
Provides a 
[Rust](https://www.rust-lang.org) 
[`Stream`](https://docs.rs/futures/0.1.21/futures/stream/trait.Stream.html)
combinator, to limit the rate at which items are produced.

[![Crates.io](https://img.shields.io/crates/v/stream_throttle.svg)](https://crates.io/crates/stream_throttle)

## Key Features
- Throttling is implemented via
[`poll()`](https://docs.rs/futures/0.1.21/futures/future/trait.Future.html#tymethod.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.

## Example throttling of `Stream`
```rust
let rate = ThrottleRate::new(5, Duration::new(2, 0));
let pool = ThrottlePool::new(rate, Timer::default());

stream::repeat(())
  .throttle(pool)
  .wait();
```

## Example throttling of `Future`
```rust
let rate = ThrottleRate::new(5, Duration::new(2, 0));
let pool = ThrottlePool::new(rate, Timer::default());

pool.queue()
  .and_then(|_| Ok(()))
  .wait();
```