Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Rate limiter supporting per-client and global limits

Thread-safe: uses parking_lot::Mutex for the global bucket and DashMap with per-entry Mutex for client buckets.

Implementations

impl RateLimiter

pub fn new(config: RateLimiterConfig) -> Self

Create a new rate limiter with the given configuration

pub fn check_rate_limit(&self, client_id: &str) -> Result<(), RateLimitError>

Check rate limit for a given client, returning an error if exceeded

Checks the per-client limit first, then the global limit (if enabled). Tokens are only consumed from the global bucket if the per-client check passes, ensuring that a per-client rejection does not waste global capacity.

pub fn try_acquire(&self, client_id: &str) -> bool

Try to acquire a token for the given client, returning true if allowed

This is a convenience wrapper around check_rate_limit.

pub fn remaining_tokens(&self, client_id: &str) -> u32

Get the number of remaining tokens for a client

Returns the per-client remaining tokens, or if per-client tracking is disabled, returns the global remaining tokens.

pub fn cleanup_expired_buckets(&self) -> usize

Remove client buckets that have been idle longer than the configured timeout

Returns the number of buckets removed.

pub fn reset(&self, client_id: &str)

Reset the rate limiter state for a specific client

pub fn reset_all(&self)

Reset all rate limiter state (global and all clients)

pub fn tracked_client_count(&self) -> usize

Get the current number of tracked clients

pub fn config(&self) -> &RateLimiterConfig

Get a reference to the configuration

Trait Implementations

impl Debug for RateLimiter

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

Formats the value using the given formatter.