Struct Throttle 

pub struct Throttle { /* private fields */ }

Limits how often one client may hit the routes it guards.

Implementations

impl Throttle

pub fn new(cache: &CacheStore, max: u64, window: Duration) -> Self

max requests per window, keyed by client IP and route.

pub fn per_minute(cache: &CacheStore, max: u64) -> Self

The common case, and the one Laravel spells throttle:60,1.

pub fn per_second(cache: &CacheStore, max: u64) -> Self

pub fn with_driver(store: Arc<dyn Cache>, max: u64, window: Duration) -> Self

Build directly on a driver, for tests and for callers that never made a CacheStore.

pub fn by( self, key: impl Fn(&Request) -> String + Send + Sync + 'static, ) -> Self

Key the bucket by something other than the client IP: an API token, a tenant, an authenticated user id.

Worth doing whenever requests arrive through a NAT or a mobile carrier, where thousands of unrelated users share one address.

Trait Implementations

impl Clone for Throttle

fn clone(&self) -> Throttle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Middleware for Throttle

fn handle(&self, request: Request, next: Next) -> BoxFuture<Response>