Struct RateLimitConfig 

#[non_exhaustive]
pub struct RateLimitConfig {
    pub requests_per_window: u64,
    pub window_secs: u64,
    pub trusted_proxy_hops: usize,
    pub max_buckets: usize,
}

Configuration for RateLimitInterceptor.

#[non_exhaustive]: build it with Default and the with_* setters, which cover every field; a struct literal is not available outside this crate, so a field added later does not break callers.

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.

requests_per_window: u64

Maximum number of requests allowed per window per caller key.

Must be non-zero.

window_secs: u64

Window duration in seconds.

Must be non-zero.

trusted_proxy_hops: usize

Number of trusted reverse-proxy hops in front of this server.

0 (the default) means x-forwarded-for is not trusted and is ignored when deriving the caller key: the header is client-controlled, so trusting it without a proxy that overwrites or appends to it lets any caller evade the limit by forging a fresh address per request.

Set to n when exactly n trusted proxies sit between the client and this server, each appending the address of its immediate peer to x-forwarded-for. The client address is then the n-th entry from the right of the header; anything further left is client-supplied and remains untrusted. If the header has fewer than n entries, the request did not traverse the expected proxy chain and the caller falls back to the shared "anonymous" key.

max_buckets: usize

Maximum number of caller buckets tracked at once.

Bounds the limiter’s memory. When the map is full, stale buckets from previous windows are evicted first; if none can be freed, requests from callers without an existing bucket are rejected (fail-closed). Must be non-zero.

Implementations

impl RateLimitConfig

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

Sets the requests allowed per window per caller key. Must be non-zero.

pub const fn with_window_secs(self, secs: u64) -> RateLimitConfig

Sets the window duration in seconds. Must be non-zero.

pub const fn with_trusted_proxy_hops(self, hops: usize) -> RateLimitConfig

Sets the number of trusted reverse-proxy hops. See trusted_proxy_hops for what trusting x-forwarded-for means.

pub const fn with_max_buckets(self, max: usize) -> RateLimitConfig

Sets the maximum number of caller buckets tracked at once. Must be non-zero.

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.