Struct RateLimiter

pub struct RateLimiter { /* private fields */ }

Rate limiter based on Token Bucket algorithm.

It allows for number of charges in specified interval. It can be used to limit API calls or anywhere with restriction over number of request per interval.

Implementations

impl RateLimiter

pub fn new(total_charges: usize, charge_every: Duration) -> RateLimiter

new rate limiter from charges and duration to renew them

// equals to 1000 requests every 60 seconds.
let limiter = RateLimiter::new(1000, time::Duration::from_secs(60));

pub fn with_rpm(rpm: usize) -> RateLimiter

new a limiter with number of requests per minute.

pub fn with_rps(rps: usize) -> RateLimiter

new a limiter with number of requests per second.

pub fn wait(&self) -> Waiter

return a future to be awaited.

It will block until there is a charge to consume.

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.