Struct RateLimiter 

pub struct RateLimiter {
    limit: u32,
    window: Duration,
    state: Mutex<State>,
}

Counts requests per key (typically a caller’s address, from caller_key) within a fixed window, and says whether the next one is still allowed.

Fields

limit: u32

window: Duration

state: Mutex<State>

Implementations

impl RateLimiter

pub fn new(limit: u32, window: Duration) -> Self

A limiter allowing limit requests per window, per key.

pub fn check(&self, key: &str) -> bool

Records one request for key and reports whether it is within the limit. A key seen for the first time, or one whose window has elapsed, starts a fresh window.

A key over MAX_KEY_LENGTH is counted against the one shared OVER_LONG_KEY bucket rather than a bucket of its own, and buckets whose windows have elapsed are dropped rather than kept — see both items’ own docs for why neither changes what this answers.

pub fn tracked_keys(&self) -> usize

How many keys this limiter is currently holding a bucket for.

The limiter’s retained footprint, for a test that needs to assert on it and for anything that later wants to log it. A bucket whose window has elapsed but which the sweep in check has not reached yet still counts.

Trait Implementations

impl Default for RateLimiter

fn default() -> Self

Returns the “default value” for a type.