Struct Limiter

pub struct Limiter { /* private fields */ }

Rate limiter backed by Redis.

Implementations

impl Limiter

pub fn new(client: Client) -> Self

Create a new limiter with the given Redis client.

pub fn set_key_prefix(self, key_prefix: &str) -> Self

Set the key prefix for the limiter’s Redis keys.

pub fn reset(&self, key: &str) -> Result<(), RedisError>

Reset the limit for a key.

pub fn allow(&self, key: &str, limit: &Limit) -> Result<LimitResult, RedisError>

Allow a request to be made within the limit.

pub fn allow_n( &self, key: &str, limit: &Limit, n: usize, ) -> Result<LimitResult, RedisError>

Allow n requests to be made within the limit.

Trait Implementations

impl Clone for Limiter

fn clone(&self) -> Limiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Limiter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.