Struct RateLimitConfig 

pub struct RateLimitConfig {
    pub max_requests: u64,
    pub window: Duration,
    pub burst_size: u64,
    pub algorithm: RateLimitAlgorithm,
    pub key_extractor: KeyExtractor,
    pub excluded_paths: Vec<String>,
    pub add_headers: bool,
    pub error_response: Option<Arc<dyn Fn(RateLimitExceeded) -> HttpResponse + Sync + Send>>,
}

Rate limit configuration.

Fields

max_requests: u64

Maximum requests per window

window: Duration

Time window duration

burst_size: u64

Burst size (for token bucket)

algorithm: RateLimitAlgorithm

Algorithm to use

key_extractor: KeyExtractor

Key extractor

excluded_paths: Vec<String>

Paths to exclude from rate limiting

add_headers: bool

Whether to add rate limit headers to response

error_response: Option<Arc<dyn Fn(RateLimitExceeded) -> HttpResponse + Sync + Send>>

Custom error response

Implementations

impl RateLimitConfig

pub fn new() -> RateLimitConfig

Create a new rate limit configuration.

pub fn max_requests(self, max: u64) -> RateLimitConfig

Set maximum requests per window.

pub fn requests_per_second(self, rps: u64) -> RateLimitConfig

Set requests per second (convenience method).

pub fn requests_per_minute(self, rpm: u64) -> RateLimitConfig

Set requests per minute.

pub fn window(self, window: Duration) -> RateLimitConfig

Set time window.

pub fn burst_size(self, size: u64) -> RateLimitConfig

Set burst size for token bucket algorithm.

pub fn algorithm(self, algo: RateLimitAlgorithm) -> RateLimitConfig

Set the rate limiting algorithm.

pub fn key_extractor(self, extractor: KeyExtractor) -> RateLimitConfig

Set the key extractor.

pub fn exclude_paths(self, paths: Vec<&str>) -> RateLimitConfig

Exclude paths from rate limiting.

pub fn add_headers(self, add: bool) -> RateLimitConfig

Whether to add rate limit headers.

pub fn error_response<F>(self, handler: F) -> RateLimitConfig

where F: Fn(RateLimitExceeded) -> HttpResponse + Send + Sync + 'static,

Set custom error response handler.

pub fn strict_login() -> RateLimitConfig

Create a strict configuration for login endpoints.

pub fn lenient_api() -> RateLimitConfig

Create a lenient configuration for API endpoints.

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<(), Error>

Formats the value using the given formatter.

impl Default for RateLimitConfig

fn default() -> RateLimitConfig

Returns the “default value” for a type.