#rate-limiting #async-context #tokio #rate #limiting #async #sliding-window

async-rate-limit

Common traits for rate limiting and implementations in async contexts

4 releases

0.1.1 Nov 3, 2024
0.1.0 Jun 19, 2024
0.0.4 Mar 8, 2024
0.0.3 Oct 4, 2023

#499 in Asynchronous

Download history 9/week @ 2024-10-02 54/week @ 2024-10-09 26/week @ 2024-10-16 115/week @ 2024-10-30 54/week @ 2024-11-06 29/week @ 2024-11-13 53/week @ 2024-11-20 20/week @ 2024-11-27 21/week @ 2024-12-04 54/week @ 2024-12-11 45/week @ 2024-12-18 26/week @ 2024-12-25 44/week @ 2025-01-01 81/week @ 2025-01-08 32/week @ 2025-01-15

188 downloads per month
Used in kraken-async-rs

MIT license

31KB
442 lines

async-rate-limit

A basic Tokio rate-limiting library providing two traits and common implementations.

badge License: MIT

Usage:

use tokio::time::{Instant, Duration};
use async_rate_limit::limiters::VariableCostRateLimiter;
use async_rate_limit::sliding_window::SlidingWindowRateLimiter;

#[tokio::main]
async fn main() -> () {
    let mut limiter = SlidingWindowRateLimiter::new(Duration::from_secs(1), 5);
    
    for _ in 0..3 {
        // these will proceed immediately, spending 3 units
        get_lite(&mut limiter).await;
    }
    // 3/5 units are spent, so this will wait for ~1s to proceed since it costs another 3
    get_heavy(&mut limiter).await;
}

// note the use of the `VariableCostRateLimiter` trait, rather than the direct type
async fn get_lite<T>(limiter: &mut T) where T: VariableCostRateLimiter {
    limiter.wait_with_cost(1).await;
    println!("Lite: {:?}", Instant::now());
}

async fn get_heavy<T>(limiter: &mut T) where T: VariableCostRateLimiter {
    limiter.wait_with_cost(3).await;
    println!("Heavy: {:?}", Instant::now());
}

Dependencies

~2.4–8.5MB
~58K SLoC