Struct rate_limiter::SleepingRateLimiter

pub struct SleepingRateLimiter {
    rate_limiter: TokenBucket,
}

Allows to limit access to some resource. Given a preferred rate (units of something) and last used amount of units of some resource, it calculates how long we should delay our next access to that resource in order to satisfy that rate.

Fields

rate_limiter: TokenBucket

Implementations

impl SleepingRateLimiter

pub fn new(rate_per_second: usize) -> Self

Constructs a instance of SleepingRateLimiter with given target rate-per-second.

pub async fn rate_limit(self, read_size: usize) -> Self

Given read_size, that is an amount of units of some governed resource, delays return of Self to satisfy configure rate.

Trait Implementations

impl Clone for SleepingRateLimiter

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.