Enum RateLimitRule 

pub enum RateLimitRule {
    Inherit,
    Off,
    Limit {
        requests: u32,
        window_secs: u64,
    },
}

How many requests one client may make in a window before an endpoint starts answering 429.

Written as "<requests>/<window>" — "100/1m", "5/30s", "1000/1h", or the bare-seconds form "100/60". Two words stand in for a number: "off" lifts the limit whatever the level above set, and "inherit" (the default, and what an omitted key means) defers to it.

The levels, narrowest last: [rate_limit] default in main.toml, a resource’s [rate_limit] all, and finally the per-action key. So a global "100/1m" with create = "5/1m" on one resource limits everything to a hundred a minute except that one endpoint, which takes five.

Variants

Inherit

Nothing said here; the level above decides.

Off

No limit, whatever the level above says.

Limit

requests per window_secs, per client address.

Fields

requests: u32

window_secs: u64

Implementations

impl RateLimitRule

pub fn parse(s: &str) -> Option<RateLimitRule>

Parse the string form. None is a spelling that means nothing — the caller turns it into a load error naming the file it came from, rather than a limit nobody asked for or, worse, a silently missing one.

pub fn as_string(&self) -> String

The canonical string form, in the units it was written in.

pub fn or(self, fallback: RateLimitRule) -> RateLimitRule

This rule if it says anything, else fallback.

pub fn limit(self) -> Option<(u32, u64)>

The limit to enforce, or None for “no limit here”.

Trait Implementations

impl Clone for RateLimitRule

fn clone(&self) -> RateLimitRule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for RateLimitRule

impl Debug for RateLimitRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RateLimitRule

fn default() -> RateLimitRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RateLimitRule

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for RateLimitRule

impl PartialEq for RateLimitRule

fn eq(&self, other: &RateLimitRule) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RateLimitRule