Struct ClientIpKeyExtractor 

pub struct ClientIpKeyExtractor;

Extract a client IP key from supported client-IP headers, falling back to the socket IP.

Use this extractor only when a platform or deployment boundary already guarantees that every accepted client-IP Header is trustworthy, such as an application reachable only through a proxy that removes or overwrites those Headers. This extractor does not validate the socket peer. If no client-IP Header is present, it falls back to an Axum ConnectInfo<SocketAddr> or a generic SocketAddr request extension. Choose one built-in IP extractor for the application’s network topology; do not layer this extractor with another one.

Implementations

impl ClientIpKeyExtractor

pub const fn new() -> Self

Construct the header-aware client IP extractor.

Trait Implementations

impl Clone for ClientIpKeyExtractor

fn clone(&self) -> ClientIpKeyExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClientIpKeyExtractor

impl Debug for ClientIpKeyExtractor

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

Formats the value using the given formatter.

impl Default for ClientIpKeyExtractor

fn default() -> ClientIpKeyExtractor

Returns the “default value” for a type.

impl Eq for ClientIpKeyExtractor

impl KeyExtractor for ClientIpKeyExtractor

fn extract<T>(&self, request: &Request<T>) -> Result<Self::Key, RateLimitError>

Extract the client IP from the request, falling back to the socket IP.

type Key = IpAddr

The type of the key.

impl PartialEq for ClientIpKeyExtractor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientIpKeyExtractor