Struct TokenBucket 

pub struct TokenBucket { /* private fields */ }

Single-instance token bucket rate limiter.

Tokens refill continuously at rate_per_second up to the burst ceiling. A call to TokenBucket::try_acquire consumes one token; returns true on success and false when the bucket is empty.

Implementations

impl TokenBucket

pub fn new(rate_per_second: f64, burst: u32) -> TokenBucket

Create a bucket with rate_per_second refill rate and burst capacity. Starts full. rate_per_second is clamped to >= 0.0; a zero rate means the bucket never refills (only the initial burst is available).

pub fn with_clock( rate_per_second: f64, burst: u32, clock: Arc<dyn Clock>, ) -> TokenBucket

Create a bucket with a custom clock.

pub fn rate_per_second(&self) -> f64

Configured refill rate (tokens per second).

pub fn burst(&self) -> u32

Configured burst ceiling.

pub fn try_acquire(&self) -> bool

Attempt to consume one token. Returns true if a token was available (and consumed); false otherwise.

pub fn try_acquire_n(&self, n: f64) -> bool

Attempt to consume n tokens.

pub fn available(&self) -> f64

Current token count. Mainly useful for tests and diagnostics.