Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Counts attempts per key and window against any Cache.

Implementations

impl RateLimiter

pub fn new(store: Arc<dyn Cache>) -> Self

pub fn with_driver(store: impl Cache) -> Self

Build a limiter over a driver held by value.

pub async fn attempt( &self, key: &str, limit: u64, window: Duration, ) -> Result<RateLimit>

Record one attempt against key and report where it stands.

The counter is incremented even when the limit is already exceeded. That is deliberate: a client that keeps hammering after a 429 keeps its window alive, which is exactly the behaviour you want from a throttle.

pub async fn too_many( &self, key: &str, limit: u64, window: Duration, ) -> Result<bool>

Whether the key has already exhausted its window, without spending an attempt on the question.

pub async fn used(&self, key: &str, window: Duration) -> Result<u64>

How many attempts the key has made in the current window.

pub async fn clear(&self, key: &str, window: Duration) -> Result<()>

Forget a key’s current window — after a successful login, say, so a user who finally got their password right is not still locked out.

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.