Struct RateLimitConfig 

pub struct RateLimitConfig {
    pub max_requests: u64,
    pub window: Duration,
    pub algorithm: RateLimitAlgorithm,
    pub include_headers: bool,
    pub retry_message: String,
}

Configuration for the rate limiting middleware.

Controls request rate limits using token bucket or sliding window algorithms. When the limit is exceeded, a 429 Too Many Requests response is returned.

Defaults

Setting	Default
max_requests	100
window	60s
algorithm	TokenBucket
include_headers	true
retry_message	“Rate limit exceeded. Please retry later.”

Response Headers (when include_headers is true)

• X-RateLimit-Limit: Maximum requests per window
• X-RateLimit-Remaining: Remaining requests in current window
• X-RateLimit-Reset: Seconds until window resets
• Retry-After: Seconds to wait (only on 429 responses)

Example

use fastapi_core::middleware::{RateLimitBuilder, RateLimitAlgorithm};

let rate_limit = RateLimitBuilder::new()
    .max_requests(1000)
    .window_secs(3600) // 1000 req/hour
    .algorithm(RateLimitAlgorithm::SlidingWindow)
    .build();

Fields

max_requests: u64

Maximum number of requests allowed per window.

window: Duration

Time window for the rate limit.

algorithm: RateLimitAlgorithm

The algorithm to use.

include_headers: bool

Whether to include rate limit headers in responses.

retry_message: String

Custom message for 429 responses.

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 Default for RateLimitConfig

fn default() -> Self

Returns the “default value” for a type.