Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Rate limiter using token bucket algorithm

This structure is thread-safe and can be shared across multiple tasks.

Implementations

impl RateLimiter

pub fn new(config: RateLimiterConfig) -> RateLimiter

Create a new rate limiter with the given configuration

Example

use ccxt_core::rate_limiter::{RateLimiter, RateLimiterConfig};
use std::time::Duration;

let config = RateLimiterConfig::new(50, Duration::from_secs(1));
let limiter = RateLimiter::new(config);

pub async fn wait(&self)

Wait until a request can be made (async)

This method will block until enough tokens are available.

Example

use ccxt_core::rate_limiter::RateLimiter;

let limiter = RateLimiter::default();
limiter.wait().await;
// Make API request here

pub async fn wait_with_cost(&self, cost: u32)

Wait until a request with custom cost can be made

Arguments

• cost - Number of tokens to consume for this request

pub async fn acquire(&self, cost: u32)

Acquire permission to make a request (wait if necessary)

This is an alias for wait() that matches the naming convention used in other rate limiting libraries.

pub async fn try_acquire(&self) -> bool

Try to make a request without waiting

Returns true if the request can proceed, false if rate limited.

Example

use ccxt_core::rate_limiter::RateLimiter;

let limiter = RateLimiter::default();
if limiter.try_acquire().await {
    // Make API request
} else {
    // Rate limited, handle accordingly
}

pub async fn try_acquire_with_cost(&self, cost: u32) -> bool

Try to make a request with custom cost without waiting

pub async fn available_tokens(&self) -> u32

Get current number of available tokens

pub async fn reset(&self)

Reset the rate limiter to full capacity

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RateLimiter

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

Formats the value using the given formatter.

impl Default for RateLimiter

fn default() -> RateLimiter

Returns the “default value” for a type.