Struct RateLimiter

pub struct RateLimiter { /* private fields */ }

A rate limiter that enforces rate limits for exchange API calls

Implementations

impl RateLimiter

pub fn new(max_requests_per_window: usize, window_milliseconds: u64) -> Self

Creates a new rate limiter

Parameters

• max_requests_per_window - Maximum number of requests allowed per time window
• window_milliseconds - Time window in milliseconds

pub async fn acquire(&self) -> Result<()>

Acquires permission to make a request, waiting if necessary

Returns

Ok(()) when permission is granted, or an error if the wait was interrupted

pub fn try_acquire(&self) -> bool

Tries to acquire permission to make a request without waiting

Returns

true if permission was granted, false if the rate limit would be exceeded

pub fn mark_request(&self)

Marks a request as completed, useful for tracking successful API calls

pub fn remaining_requests(&self) -> usize

Returns the number of remaining requests that can be made immediately

pub fn time_until_next_available_ms(&self) -> u64

Returns the time in milliseconds until the next slot becomes available

Trait Implementations

impl Debug for RateLimiter

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

Formats the value using the given formatter.