Enum RateLimitKey 

pub enum RateLimitKey {
    Ip(IpAddr),
    Header(String),
    Route(Uuid),
    Global,
}

Key for rate limiting: who a bucket is counting.

Variants

Ip(IpAddr)

Rate limit by IP address. Build it with RateLimitKey::client_ip, which groups an IPv6 client by its /64.

Header(String)

Rate limit by custom header value. Build it with RateLimitKey::header_value, which stores a digest rather than the value itself.

Route(Uuid)

Rate limit by route ID

Global

Global rate limit

Implementations

impl RateLimitKey

pub fn client_ip(ip: IpAddr) -> Self

The key for a client connecting from ip.

An IPv6 client is keyed by its /64. A single host is normally handed a whole /64, and can pick any address in it for each connection; keyed by the full address, every request could come from a fresh bucket, which is the same as no limit at all.

An IPv4 client arriving on an IPv6 socket appears as ::ffff:a.b.c.d. That is canonicalised back to IPv4 first, or every IPv4 client would share the one /64 that holds all the mapped addresses.

pub fn header_value(value: &[u8]) -> Self

The key for a header value.

A digest, not the value: header values are client-chosen and can be kilobytes long, and the table holds up to RateLimitDefaults::max_tracked_keys of them. It also keeps API keys and the like out of the limiter’s memory.

Trait Implementations

impl Clone for RateLimitKey

fn clone(&self) -> Self

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 Eq for RateLimitKey

impl Hash for RateLimitKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RateLimitKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RateLimitKey