Struct rate_limiter::token_bucket::TokenBucket

pub struct TokenBucket {
    rate_per_second: usize,
    available: usize,
    requested: usize,
    last_update: Instant,
}

Implementation of the Token Bucket algorithm for the purpose of rate-limiting access to some abstract resource.

Fields

rate_per_second: usize

available: usize

requested: usize

last_update: Instant

Implementations

impl TokenBucket

pub fn new(rate_per_second: usize) -> Self

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

fn calculate_delay(&self) -> Duration

fn update_units(&mut self, now: Instant) -> usize

pub fn rate_limit(&mut self, requested: usize, now: Instant) -> Option<Duration>

Calculates Duration by which we should delay the next call to some governed resource in order to satisfy configured rate limit.

fn token_limit(&self) -> usize

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> TokenBucket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenBucket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.