Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Token bucket rate limiter.

Implements the token bucket algorithm for rate limiting:

• Tokens are added at a steady rate up to a maximum (burst) capacity
• Each operation consumes one token
• If no tokens are available, behavior depends on backpressure strategy

Implementations

impl RateLimiter

pub fn new(config: RateLimitConfig) -> Self

Creates a new rate limiter with the given configuration.

pub fn with_rate(entities_per_second: f64) -> Self

Creates a rate limiter with a simple rate (entities per second).

pub fn disabled() -> Self

Creates a disabled rate limiter (always allows).

pub fn acquire(&mut self) -> RateLimitAction

Acquires a token, blocking if necessary.

Returns the action taken to acquire the token.

pub fn try_acquire(&mut self) -> Option<RateLimitAction>

Tries to acquire a token without blocking.

Returns Some(action) if a token was acquired, None if rate limited.

pub fn acquire_timeout(&mut self, timeout: Duration) -> Option<RateLimitAction>

Acquires a token with a timeout.

Returns the action taken, or None if the timeout was exceeded.

pub fn stats(&self) -> RateLimiterStats

Returns the current statistics.

pub fn reset(&mut self)

Resets the rate limiter to initial state.

pub fn available_tokens(&self) -> f64

Returns the current number of available tokens.

pub fn config(&self) -> &RateLimitConfig

Returns the configuration.

pub fn set_rate(&mut self, entities_per_second: f64)

Updates the rate limit.

pub fn set_enabled(&mut self, enabled: bool)

Enables or disables the rate limiter.

pub fn process_buffer(&mut self) -> Vec<Duration>

Processes the buffer, releasing items as tokens become available.