Struct throttler::simple::SimpleThrottler

pub struct SimpleThrottler { /* fields omitted */ }

SimpleThrottler is a struct that has a number of operations allowed per time interval and the length of the inverval. It also stores the number of operations left to do in the current iterval, and when did the current interval start.

Methods

impl SimpleThrottler

fn new(operations_per_interval: u64, time_interval: Duration) -> SimpleThrottler

Constructs a new SimpleThrottler. Takes as parameters the number of operations allowed per time interval, and the length of the interval.

Examples

use throttler::simple::SimpleThrottler;
use std::time::Duration;
 
// Create a SimpleThrottler that allows 1000 operations every 20
// seconds.
let throttler = SimpleThrottler::new(1000, Duration::new(20, 0));

fn wait(&mut self)

Waits until the throttler allows to make more operations. If no more operations are allowed in the current time interval, the throttler waits for it to end.

Examples

use throttler::simple::SimpleThrottler;
use std::time::Duration;
 
// Create a throttler that allows 3 operations every second.
let mut throttler = SimpleThrottler::new(3, Duration::new(1, 0));
 
// This will print all numbers from 0 to 10 in bursts of 3.
for i in 0..10 {
    throttler.wait();
    println!("{}", i);
}

fn reset(&mut self)

Resets the throttler completely. After calling reset the throttler is restored to its initial state, like after the new call.

Examples

use throttler::simple::SimpleThrottler;
use std::time::Duration;
 
// Create a 
let mut throttler = SimpleThrottler::new(3, Duration::new(1, 0));
// This will print all numbers from 0 to 10 together, because the
// throttler always gets reseted.
for i in 0..10 {
    throttler.wait();
    println!("{}", i);
    throttler.reset()
}