Struct RateLimitConfig 

pub struct RateLimitConfig {
    pub enabled: bool,
    pub default: RateLimitRule,
    pub trust_proxy_headers: bool,
    pub cleanup_interval_secs: u64,
    pub stale_after_secs: u64,
}

How many requests one client may make, before the API starts answering 429 Too Many Requests.

Off until asked for: default = "off" means an app that says nothing here is limited nowhere, and an upgrade cannot start refusing traffic that used to be served. Naming a rate switches it on for every endpoint at once:

[rate_limit]
default = "100/1m"

A resource narrows or lifts that per action in its own [rate_limit] section, and a function does the same with a rate_limit key in its functions/<name>.toml — see crate::RateLimits.

Who “one client” is

The peer socket address, which a caller cannot forge. Behind a reverse proxy that is the proxy’s address for every request — one bucket for everybody, throttling all callers together — so a deployment behind one has to set trust_proxy_headers = true and make sure the proxy overwrites X-Forwarded-For rather than appending to it. Trusting that header with nothing in front of the server hands every caller their own rate limit for the price of a header line, which is the same as having none.

Fields

enabled: bool

Turn every limit off — the app’s, the resources’ and the functions’ — without deleting what they say. The switch to flip while an incident is being diagnosed.

default: RateLimitRule

The rule every endpoint gets unless something narrower says otherwise. "off" (the default) limits nothing.

trust_proxy_headers: bool

Read the client address from X-Forwarded-For / X-Real-IP when present, instead of the peer socket. Only true behind a proxy you control; see the section note above.

cleanup_interval_secs: u64

How often the tracked clients are swept for buckets nobody has used.

stale_after_secs: u64

How long a client’s bucket is kept after their last request. Bounds what a flood of one-request-each addresses can cost in memory.

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.