Struct ClientIp 

pub struct ClientIp { /* private fields */ }

The resolved client IP, and where it came from.

This is a Rocket request guard. It reads a ClientIpConfig out of Rocket’s managed state, so the config has to be passed to rocket::build().manage(config), and it falls back to the address of the connection that Rocket records in Request::remote.

Implementations

impl ClientIp

pub const fn ip(&self) -> IpAddr

Return the resolved client IP.

pub const fn source(&self) -> &ClientIpSource

Return where the client IP came from.

Use this to tell a header value apart from the socket peer IP, for example when logging.

pub fn into_parts(self) -> (IpAddr, ClientIpSource)

Consume this value and return the client IP and its source.

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 Debug for ClientIp

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

Formats the value using the given formatter.

impl Display for ClientIp

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

Formats the value using the given formatter.

impl Eq for ClientIp

impl From<ClientIp> for IpAddr

fn from(client_ip: ClientIp) -> Self

Converts to this type from the input type.

impl<'r> FromRequest<'r> for ClientIp

type Error = ClientIpRejection

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0>, ) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl<'r> FromRequest<'r> for &'r ClientIp

type Error = ClientIpRejection

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0>, ) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata.

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientIp