Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

RateLimiter is the main entry point for rate limiting

It can be used in single-tier mode or multi-tier mode.

Implementations

impl RateLimiter

pub fn builder() -> RateLimiterBuilder

Create a builder for configuring the rate limiter

Example

use rateflow::{RateLimiter, Window};

let limiter = RateLimiter::builder()
    .limit(100)
    .window(Window::Minute)
    .build()
    .unwrap();

pub async fn check(&self, client_id: impl Into<String>) -> bool

Check if a request is allowed for the given client

Returns true if the request should be allowed, false otherwise.

Example

use rateflow::{RateLimiter, Window};

let limiter = RateLimiter::builder()
    .limit(10)
    .window(Window::Second)
    .build()
    .unwrap();

if limiter.check("user@example.com").await {
    println!("Request allowed");
} else {
    println!("Rate limit exceeded");
}

pub async fn check_tier( &self, tier: impl Into<String>, client_id: impl Into<String>, ) -> bool

Check if a request is allowed for the given client and tier

Returns true if the request should be allowed, false otherwise.

Example

use rateflow::{RateLimiter, Tier, Window};

let limiter = RateLimiter::builder()
    .add_tier(Tier::new("free").limit(100))
    .add_tier(Tier::new("premium").limit(1000))
    .build()
    .unwrap();

if limiter.check_tier("premium", "user@example.com").await {
    println!("Request allowed");
}

pub async fn reset(&self, client_id: impl Into<String>)

Reset the state for a specific client

This removes all tracking data for the client, effectively resetting their rate limit.

pub async fn reset_tier( &self, tier: impl Into<String>, client_id: impl Into<String>, )

Reset the state for a specific client and tier

pub fn client_count(&self) -> usize

Get the number of clients currently being tracked