Struct ClientIp 

pub struct ClientIp {
    pub ip: IpAddr,
    pub forwarded: bool,
}

Best-effort client IP for the current request. Always present (see the module doc for the resolution order and the security caveat).

Fields

ip: IpAddr

The resolved address. 0.0.0.0 only when nothing in the chain matched.

forwarded: bool

true when the address came from X-Forwarded-For or X-Real-IP, false when it came from the transport peer or the default.

Implementations

impl ClientIp

pub const fn unknown() -> Self

Last-resort default: 0.0.0.0, forwarded = false.

Trait Implementations

impl Clone for ClientIp

fn clone(&self) -> ClientIp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClientIp

impl Debug for ClientIp

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

Formats the value using the given formatter.

impl Eq for ClientIp

impl<'a> FromRequest<'a> for ClientIp

async fn from_request(req: &'a Request, _body: &mut RequestBody) -> Result<Self>

Extract from request head and body.

fn from_request_without_body( req: &'a Request, ) -> impl Future<Output = Result<Self, Error>> + Send

Extract from request head.

impl Hash for ClientIp

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 ClientIp

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ClientIp