Struct TrustedProxyClientIpKeyExtractor 

pub struct TrustedProxyClientIpKeyExtractor { /* private fields */ }

Extract a client IP key only when the socket peer satisfies an application trust policy.

Use this extractor when trusted proxies and direct or untrusted peers may reach the same application. It requires the socket peer and validates that peer with the synchronous policy supplied to Self::new before reading any forwarding Header. Choose one built-in IP extractor for the application’s network topology; do not layer this extractor with another one.

An untrusted peer always uses its socket IP and all forwarding Headers are ignored. A trusted peer uses the same Header order and strict parsing as ClientIpKeyExtractor, falling back to the peer when no supported Header is present.

The policy establishes which transport peers may assert a client address; Header parsing does not authenticate the value. Applications must still ensure every trusted proxy removes or overwrites each supported client-IP Header.

Implementations

impl TrustedProxyClientIpKeyExtractor

pub fn new<F>(is_trusted_proxy: F) -> Self

where F: Fn(IpAddr) -> bool + Send + Sync + 'static,

Construct an extractor with an application-defined trusted-peer policy.

Trait Implementations

impl Clone for TrustedProxyClientIpKeyExtractor

fn clone(&self) -> TrustedProxyClientIpKeyExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrustedProxyClientIpKeyExtractor

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

Formats the value using the given formatter.

impl KeyExtractor for TrustedProxyClientIpKeyExtractor

type Key = IpAddr

The type of the key.

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

Extract the key from the request.