Enum RateLimitKey 

#[non_exhaustive]
pub enum RateLimitKey {
    User,
    Ip,
    Tenant,
    UserAction,
    Global,
    Custom(String),
}

Rate limit key type for bucketing.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

User

Per-user rate limiting.

Ip

Per-IP rate limiting.

Tenant

Per-tenant rate limiting.

UserAction

Per-user-action rate limiting (combines user and action).

Global

Global rate limiting (single bucket for all requests).

Custom(String)

Custom claim-based bucketing. The inner string is the JWT claim name whose value is used as the bucket discriminator. Backends receive this variant via build_key and may further customise the resolution logic.

Macro syntax: #[query(rate_limit(requests = 100, per = "1m", key = "custom:claim_name"))]

Implementations

impl RateLimitKey

pub fn as_str(&self) -> &str

Convert to a string representation.

For Self::Custom this returns "custom" — use Self::custom_name to retrieve the inner claim name.

pub fn custom_name(&self) -> Option<&str>

Return the inner claim name for Self::Custom, or None for the standard variants.

Trait Implementations

impl Clone for RateLimitKey

fn clone(&self) -> RateLimitKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitKey

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

Formats the value using the given formatter.

impl Default for RateLimitKey

fn default() -> RateLimitKey

Returns the “default value” for a type.

impl FromStr for RateLimitKey

type Err = ParseRateLimitKeyError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for RateLimitKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RateLimitKey

impl StructuralPartialEq for RateLimitKey