Struct TokenBucketState

pub struct TokenBucketState { /* private fields */ }

All required state that can be shared among many TokenBucketRateLimiters

TokenBucketRateLimiters take Arc<Mutex<TokenBucketState>> so a single state (including the replenishment task) can be shared among many rate limiters, e.g. when a single API has multiple endpoints, each requiring different costs but counting against the same user rate limit.

Implementations

impl TokenBucketState

pub fn new( max_tokens: usize, replace_amount: usize, replace_duration: Duration, ) -> Self

Create a new TokenBucketState with a full bucket of max_tokens that will be replenished with replace_amount tokens every replace_duration.

Trait Implementations

impl Debug for TokenBucketState

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

Formats the value using the given formatter.

impl Drop for TokenBucketState

fn drop(&mut self)

Executes the destructor for this type.