#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

#494 in Asynchronous

Download history 17/week @ 2024-08-26 115/week @ 2024-09-02 34/week @ 2024-09-09 13/week @ 2024-09-16 22/week @ 2024-09-23 5/week @ 2024-09-30 46/week @ 2024-10-07 40/week @ 2024-10-14 10/week @ 2024-10-28 151/week @ 2024-11-04 24/week @ 2024-11-11 58/week @ 2024-11-18 22/week @ 2024-11-25 18/week @ 2024-12-02 52/week @ 2024-12-09

153 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–7.5MB
~58K SLoC