Struct IpKeyExtractor 

pub struct IpKeyExtractor;

Rate limit by client IP address from X-Forwarded-For or X-Real-IP headers.

Security Warning

This extractor trusts client-supplied headers, which can be spoofed!

Only use this extractor when:

1. Your application runs behind a trusted reverse proxy (nginx, Cloudflare, etc.)
2. The proxy is configured to set/override these headers
3. Clients cannot connect directly to your application

For direct client connections, use ConnectedIpKeyExtractor instead.

How Proxies Work

When a request passes through proxies:

• X-Forwarded-For: client_ip, proxy1_ip, proxy2_ip
• The first IP is typically the original client
• Each proxy appends its own IP

This extractor takes the first IP from X-Forwarded-For, which is correct only if your trusted proxy always sets/overwrites this header.

Fallback Behavior

Falls back to "unknown" when no IP header is present, which means all such requests share the same rate limit bucket. This may not be desirable in production - consider using TrustedProxyIpKeyExtractor for better control.

Trait Implementations

impl Clone for IpKeyExtractor

fn clone(&self) -> IpKeyExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpKeyExtractor

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

Formats the value using the given formatter.

impl KeyExtractor for IpKeyExtractor

fn extract_key(&self, req: &Request) -> Option<String>

Extract the key string from the request.