Enum KeySourceConfig 

#[non_exhaustive]
pub enum KeySourceConfig {
    Ip,
    Header {
        name: String,
    },
    JwtClaim {
        claim: String,
    },
}

How a rule derives its limit key. All sources fall back to the client IP when their value is absent, so a limit can’t be bypassed by omitting a header or authenticating anonymously. Written as a tagged map, e.g. key: { type: jwt_claim, claim: sub }; omitting key defaults to ip.

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.

Ip

Client IP (trusted-proxy X-Forwarded-For aware). { type: ip }.

Header

Value of a named request header (e.g. an API key). { type: header, name: x-api-key }.

Fields

name: String

Header whose value identifies the client.

JwtClaim

Value of a claim from the validated JWT (provider-agnostic). { type: jwt_claim, claim: sub }.

Fields

claim: String

Claim whose value identifies the principal.

Trait Implementations

impl Clone for KeySourceConfig

fn clone(&self) -> KeySourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeySourceConfig

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

Formats the value using the given formatter.

impl Default for KeySourceConfig

fn default() -> KeySourceConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeySourceConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeySourceConfig

impl PartialEq for KeySourceConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeySourceConfig