Throttle

Crates.io Documentation Build Status

A simple, configurable throttle for slowing down code. When do you actually want to slow down code? To avoid resource contention and browning out downstream services.

```rust // simple throttle configured for 10 TPS let mut throttle = Throttle::newtpsthrottle(10.0);

let iteration_start = Instant::now();

// the first one is free! throttle.acquire(());

// the first iteration is free, subsequent iterations // will be slowed down to a rate of 10 TPS, or one iteration // every 100 milliseconds for _i in 0..10 { throttle.acquire(()); }

println!("elapsed time: {:?}", iteration_start.elapsed());

asserteq!(iterationstart.elapsed().as_secs() == 1, true); ```

Throttle is based on a functional interface, so it can go beyond constant tps rate limiting to facilitating variable-rate throttling based on conditions entirely up to your program.

```rust let mut throttle = Throttle::newvariablethrottle( |iteration: u32, | Duration::frommillis(arg));

let iteration_start = Instant::now();

// the first iteration is free, subsequent iterations // will be slowed down for i in 0..5 { throttle.acquire(i * 100); }

asserteq!(iterationstart.elapsed().as_secs() == 1, true); ```

License

I want you to be able to use this software regardless of who you may be, what you are working on, or the environment in which you are working on it - I hope you'll use it for good and not evil! To this end, Throttle is licensed under the 2-clause BSD license, with other licenses available by request. Happy coding!