Struct RateLimitConfig 

#[non_exhaustive]
pub struct RateLimitConfig {
    pub per_second: u64,
    pub burst_size: u32,
    pub use_headers: bool,
    pub cleanup_interval_secs: u64,
    pub max_keys: usize,
}

Configuration for the rate-limiting middleware.

Uses a token-bucket algorithm. Each unique key (typically the client IP) gets burst_size tokens; one token is replenished every 1 / per_second seconds. When tokens are exhausted the request receives a 429 Too Many Requests response.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

per_second: u64

Token replenish rate (tokens per second).

burst_size: u32

Maximum number of tokens (requests) allowed in a burst.

use_headers: bool

Whether to include x-ratelimit-* headers in responses.

cleanup_interval_secs: u64

How often (in seconds) to purge expired entries from the rate-limit map.

max_keys: usize

Maximum number of tracked keys. New keys are rejected when the limit is reached. Set to 0 to disable the cap.

Trait Implementations

impl Clone for RateLimitConfig

fn clone(&self) -> RateLimitConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitConfig

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

Formats the value using the given formatter.

impl Default for RateLimitConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimitConfig

where RateLimitConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.