Struct RateLimitConfig 

pub struct RateLimitConfig { /* private fields */ }

Configuration for the rate limiter middleware.

Build with RateLimitConfig::new() and chain methods to set the request limit, window duration, rejection status, and key extraction strategy. Then pass to RateLimitLayer::new().

Examples

use std::time::Duration;
use http::StatusCode;
use rune_axum_ratelimit::RateLimitConfig;

let config = RateLimitConfig::new()
    .requests(50)
    .window(Duration::from_secs(30))
    .status(StatusCode::TOO_MANY_REQUESTS);

Implementations

impl RateLimitConfig

pub fn new() -> RateLimitConfig

Creates a RateLimitConfig with defaults: 100 req/60 s, X-Forwarded-For keying, 429 Too Many Requests rejection.

pub fn requests(self, n: u64) -> RateLimitConfig

Sets the maximum number of requests allowed per window per client.

Defaults to 100.

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

Sets the duration of each fixed window.

Defaults to 60 seconds.

pub fn status(self, s: StatusCode) -> RateLimitConfig

Sets the HTTP status code returned when the limit is exceeded.

Defaults to 429 Too Many Requests.

pub fn key(self, k: KeyExtractor) -> RateLimitConfig

Sets the strategy used to identify each client.

Defaults to KeyExtractor::XForwardedFor.

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.