Struct TokenBucket 

pub struct TokenBucket {
    pub tokens: f64,
    pub max_tokens: f64,
    pub refill_rate: f64,
    pub last_refill: Instant,
}

A token-bucket rate limiter.

Tokens refill continuously at refill_rate tokens/sec up to max_tokens. Each try_acquire consumes one token. Thread-safe when wrapped in DashMap (exterior mutability via get_mut).

Fields

tokens: f64

max_tokens: f64

refill_rate: f64

last_refill: Instant

Implementations

impl TokenBucket

pub fn new(max_tokens: f64, refill_rate: f64) -> Self

Create a new bucket starting full.

pub fn new_at(max_tokens: f64, refill_rate: f64, now: Instant) -> Self

Create a bucket with a specific start time (useful for testing).

pub fn try_acquire(&mut self) -> bool

Refill tokens based on elapsed time, then try to consume one token. Returns true if the token was acquired, false if bucket is empty.

pub fn try_acquire_at(&mut self, now: Instant) -> bool

Same as try_acquire but accepts a timestamp (for deterministic testing).

pub fn available(&mut self) -> f64

Current token count (after refill).

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.