Struct TokenBucket 

pub struct TokenBucket { /* private fields */ }

Token bucket rate limiter

The token bucket algorithm works by:

• Adding tokens at a fixed rate (rate per second)
• Consuming one token per task execution
• Allowing bursts up to the bucket capacity

This is the default and recommended rate limiter for most use cases.

Implementations

impl TokenBucket

pub fn new(config: RateLimitConfig) -> Self

Create a new token bucket rate limiter

pub fn with_rate(rate: f64) -> Self

Create a token bucket with default configuration

Trait Implementations

impl Debug for TokenBucket

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

Formats the value using the given formatter.

impl RateLimiter for TokenBucket

fn try_acquire(&mut self) -> bool

Try to acquire a permit to execute a task

fn acquire(&mut self) -> Duration

Acquire a permit, blocking until available

fn time_until_available(&self) -> Duration

Get the time until a permit will be available

fn available_permits(&self) -> u32

Get the current number of available permits

fn reset(&mut self)

Reset the rate limiter to its initial state

fn set_rate(&mut self, rate: f64)

Update the rate limit configuration

fn config(&self) -> &RateLimitConfig

Get current configuration