Enum KeyExtractor 

pub enum KeyExtractor {
    XForwardedFor,
    Header(HeaderName),
}

Determines how a per-client key is extracted from the request.

The key is used to track and limit each client independently. If the configured header is absent the request passes through without being counted.

Examples

use http::HeaderName;
use rune_axum_ratelimit::KeyExtractor;

// Rate-limit by the first IP in X-Forwarded-For (set by most reverse proxies)
let by_ip = KeyExtractor::XForwardedFor;

// Rate-limit by an API key sent in a custom header
let by_key = KeyExtractor::Header(HeaderName::from_static("x-api-key"));

Variants

XForwardedFor

Uses the first (leftmost) IP in the X-Forwarded-For header.

[!WARNING] Clients can spoof this header unless your reverse proxy strips and re-adds it. Configure your proxy to overwrite X-Forwarded-For with the true client IP.

Header(HeaderName)

Uses the value of a named request header as the client key.

Suitable for API key–based rate limiting: pass the header that carries the key, e.g. HeaderName::from_static("x-api-key").

Trait Implementations

impl Clone for KeyExtractor

fn clone(&self) -> KeyExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyExtractor

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

Formats the value using the given formatter.