Struct tower_governor::key_extractor::PeerIpKeyExtractor

pub struct PeerIpKeyExtractor;

A KeyExtractor that uses peer IP as key. This is the default key extractor and it may no do want you want.

Warning: this key extractor enforces rate limiting based on the peer IP address.

This means that if your app is deployed behind a reverse proxy, the peer IP address will always be the proxy’s IP address. In this case, rate limiting will be applied to all incoming requests as if they were from the same user.

If this is not the behavior you want, you may:

• Use the SmartIpKeyExtractor to get the IP from the Forwarded or X-Forwarded-For headers that most proxies set
• implement your own KeyExtractor that tries to get IP from the Forwarded or X-Forwarded-For headers that most reverse proxies set
• make absolutely sure that you only trust these headers when the peer IP is the IP of your reverse proxy (otherwise any user could set them to fake its IP)

Trait Implementations

impl Clone for PeerIpKeyExtractor

fn clone(&self) -> PeerIpKeyExtractor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeerIpKeyExtractor

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

Formats the value using the given formatter.

impl KeyExtractor for PeerIpKeyExtractor

type Key = IpAddr

The type of the key.

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

Extraction method, will return GovernorError response when the extract failed

impl PartialEq for PeerIpKeyExtractor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PeerIpKeyExtractor

impl Eq for PeerIpKeyExtractor

impl StructuralPartialEq for PeerIpKeyExtractor