Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Rate limiter with per-key token buckets.

Entries are forgotten once their bucket has refilled, which loses nothing: a full bucket answers exactly as a new one would. That happens in start_cleanup, and on demand when the table reaches its cap. crate::vendored::ProxyService starts the cleanup task when it begins serving; anything else that holds a RateLimiter for long should start it too.

Implementations

impl RateLimiter

pub fn new(defaults: RateLimitDefaults) -> Self

Create a new rate limiter.

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

Check if a request should be allowed, against the configured defaults.

Returns true if the request is allowed, false if rate limited.

pub fn check_with_config( &self, scope: Uuid, key: RateLimitKey, rate_per_sec: f64, burst: u32, ) -> bool

Check against a limit of rate_per_sec tokens a second and a burst of burst, in the bucket for key within scope.

scope keeps limits apart: pass the route’s identity, so that one route’s traffic is not counted against another’s.

pub fn remaining(&self, key: &RateLimitKey) -> Option<u64>

Get remaining tokens for a key under the defaults (approximate).

pub fn tracked_keys(&self) -> usize

How many buckets are held.

pub async fn start_cleanup(self: Arc<Self>, cancel_token: CancellationToken)

Start background cleanup task.

Trait Implementations

impl Default for RateLimiter

fn default() -> Self

Returns the “default value” for a type.