Enum ClientIpSource 

pub enum ClientIpSource {
    ConfiguredHeader(Uncased<'static>),
    ChainHeader(Uncased<'static>),
    Socket,
}

Where a ClientIp came from.

Variants

ConfiguredHeader(Uncased<'static>)

The client IP header of a trusted proxy, such as X-Real-IP.

The name inside is the header that gave the address.

ChainHeader(Uncased<'static>)

One hop of a chain header, such as X-Forwarded-For or Forwarded.

The name inside is the header that gave the address.

Socket

The socket peer IP, which is the address the connection came from.

This is the answer whenever no header is trusted enough to change it.

Implementations

impl ClientIpSource

pub const fn header_name(&self) -> Option<&Uncased<'static>>

Return the header that gave the address, or None for Self::Socket.

Trait Implementations

impl Clone for ClientIpSource

fn clone(&self) -> ClientIpSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientIpSource

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

Formats the value using the given formatter.

impl Eq for ClientIpSource

impl Hash for ClientIpSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClientIpSource

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientIpSource