Struct ClientIpRateKey 

#[non_exhaustive]
pub struct ClientIpRateKey { /* private fields */ }

Available on crate feature std only.

An InputToRateKey extractor keying on the client IP address, resolved via client_ip: Forwarded information (populated by e.g. forwarded-header or PROXY-protocol layers) wins over the transport peer address (SocketInfo). Only populate Forwarded from a trusted proxy boundary: accepting a client-supplied forwarding header lets that client choose and rotate its own rate key.

The resolved address is canonicalised before keying: IPv4-mapped IPv6 peers (::ffff:a.b.c.d) collapse to their IPv4 form, and IPv6 clients are aggregated to with_ipv6_prefix (default /64). Without this a single client keys to 2^64 distinct buckets and per-client limiting is a no-op against exactly the clients most able to abuse it.

The aggregation prefix and the policy’s max_keys must be sized together: one routed /48 contains 65 536 /64 keys, equal to the default KeyedRatePolicy capacity. Aggregate more broadly when one client or tenant may legitimately control many /64 networks.

Implementations

impl ClientIpRateKey

pub const fn new() -> Self

Create a new ClientIpRateKey, aggregating IPv6 clients to /64.

pub fn with_ipv6_prefix(self, prefix: u8) -> Self

Aggregate IPv6 client addresses to this prefix length (clamped to 1..=128) before keying; 128 keys on the exact address. IPv4 clients are always keyed on the exact address. Choose this together with KeyedRatePolicy::set_max_keys: a broader prefix consumes fewer cache entries but groups more clients into one budget.

pub fn set_ipv6_prefix(&mut self, prefix: u8) -> &mut Self

Aggregate IPv6 client addresses to this prefix length (clamped to 1..=128) before keying; 128 keys on the exact address. IPv4 clients are always keyed on the exact address. Choose this together with KeyedRatePolicy::set_max_keys: a broader prefix consumes fewer cache entries but groups more clients into one budget.

Trait Implementations

impl Clone for ClientIpRateKey

fn clone(&self) -> ClientIpRateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClientIpRateKey

impl Debug for ClientIpRateKey

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

Formats the value using the given formatter.

impl Default for ClientIpRateKey

fn default() -> Self

Returns the “default value” for a type.

impl<Input> InputToRateKey<Input> for ClientIpRateKey

where Input: ExtensionsRef + Send + Sync + 'static,

type Key = IpAddr

The key type produced by this extractor.

fn rate_key(&self, input: &Input) -> Result<Option<Self::Key>, BoxError>

Derive the rate key from the given input.