Enum XForwardedFor 

#[non_exhaustive]
pub enum XForwardedFor {
    Verified,
    Resolved,
    Append,
    Preserve,
    Remove,
}

What X-Forwarded-For carries upstream. X-Real-IP and Forwarded (RFC 7239) from the request reach the upstream only with preserve; in every other mode they are removed, since they would contradict it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Verified

The verified part of the chain: the resolved client, the trusted proxies between it and this proxy, then this proxy’s peer (203.0.113.7, 10.0.0.2, 10.0.0.1). Whatever the client wrote left of its own address is dropped, so the first element is always the client, and an upstream walking the list from the right reaches the same client. Absent when no address resolved.

Resolved

The resolved address alone; absent when none resolved.

Append

The request’s list as it arrived, then this proxy’s peer, as nginx, Envoy, HAProxy and most load balancers append. Its first element is whatever the client wrote.

Preserve

The request’s X-Forwarded-For, X-Real-IP and Forwarded as they arrived, nothing added. Its first element is whatever the client wrote.

Remove

No X-Forwarded-For.

Trait Implementations

impl Clone for XForwardedFor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for XForwardedFor

impl Debug for XForwardedFor

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

Formats the value using the given formatter.

impl Default for XForwardedFor

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for XForwardedFor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for XForwardedFor

impl PartialEq for XForwardedFor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for XForwardedFor