rate-net 1.0.0

A powerful, lock-free rate limiter for Rust: multiple algorithms behind one trait, sharded per-key state, bounded-memory eviction, retry-after, and a one-line Tier-1 API. Built against hostile traffic.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Per-key limiting: every IP, user, or endpoint gets its own allowance.
//!
//! ```text
//! cargo run --example per_key
//! ```

use rate_net::RateLimiter;
use std::net::{IpAddr, Ipv4Addr};

fn main() {
    // Two requests per second, applied independently per key.
    let limiter = RateLimiter::per_second(2);

    let alice = IpAddr::V4(Ipv4Addr::new(203, 0, 113, 7));
    let bob = IpAddr::V4(Ipv4Addr::new(198, 51, 100, 9));

    // Alice spends her whole allowance.
    println!("alice #1: {}", verdict(limiter.check(alice).is_allow()));
    println!("alice #2: {}", verdict(limiter.check(alice).is_allow()));
    println!("alice #3: {}", verdict(limiter.check(alice).is_allow()));

    // Bob is on a different key, so he is untouched by Alice's traffic.
    println!("bob   #1: {}", verdict(limiter.check(bob).is_allow()));

    // String keys work the same way — per user, per tenant, per endpoint.
    println!("user:42 : {}", verdict(limiter.check("user:42").is_allow()));
    println!(
        "GET /api: {}",
        verdict(limiter.check("GET /api").is_allow())
    );
}

fn verdict(allowed: bool) -> &'static str {
    if allowed { "allowed" } else { "denied" }
}