Struct RateLimiter

pub struct RateLimiter { /* private fields */ }

Advanced rate limiter for API calls that maintains a request history

Implementations

impl RateLimiter

pub fn new(limit_type: RateLimitType) -> Self

Creates a new rate limiter with the specified limit type

pub fn with_safety_margin(&mut self, safety_margin: f64) -> Self

Creates a new rate limiter with a custom safety margin

Arguments

• safety_margin - A value between 0.0 and 1.0 representing the percentage of the actual limit to use (e.g., 0.8 means use 80% of the actual limit)

pub fn limit_type(&self) -> RateLimitType

Returns the rate limit type for this limiter

pub fn effective_limit(&self) -> usize

Returns the effective request limit (after applying safety margin)

pub async fn current_request_count(&self) -> usize

Gets the current number of requests in the time window

pub async fn time_until_next_request_ms(&self) -> u64

Gets the time until the next request can be made (in milliseconds) Returns 0 if a request can be made immediately

pub async fn notify_rate_limit_exceeded(&self)

Notifies the rate limiter that a rate limit error has been encountered This will cause the rate limiter to enforce a mandatory cooldown period

pub async fn wait(&self)

Waits if necessary to respect the rate limit This method is thread-safe and can be called from multiple threads concurrently

pub async fn get_stats(&self) -> RateLimiterStats

Gets statistics about the current rate limit usage

Trait Implementations

impl Debug for RateLimiter

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

Formats the value using the given formatter.