Struct TokenBucket 

pub struct TokenBucket {
    pub capacity: f64,
    pub refill_rate: f64,
    /* private fields */
}

A token-bucket rate limiter.

Tokens accumulate at refill_rate tokens per millisecond up to capacity. Each request consumes tokens tokens. Requests that cannot be served immediately are rejected (non-blocking).

Fields

capacity: f64

Maximum number of tokens the bucket can hold.

refill_rate: f64

Token refill rate in tokens per millisecond.

Implementations

impl TokenBucket

pub fn new(capacity: f64, refill_rate: f64, now_ms: u64) -> Self

Create a new token bucket, starting full.

pub fn try_consume(&mut self, tokens: f64, now_ms: u64) -> bool

Try to consume tokens from the bucket.

Returns true if the tokens were available and consumed, false otherwise (no tokens are consumed on failure).

pub fn available(&mut self, now_ms: u64) -> f64

Current available tokens (after refilling to now_ms).

pub fn is_full(&mut self, now_ms: u64) -> bool

Returns true if the bucket is completely full.

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> TokenBucket

Returns a duplicate 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.