Struct RemoteIp 

pub struct RemoteIp(pub Option<IpAddr>);

Extractor for the client’s IP address, from Cloudflare’s CF-Connecting-IP header.

Cloudflare sets CF-Connecting-IP on every request that reaches a Worker and replaces any value the client sent, so it can be trusted, unlike X-Forwarded-For (Rails’ request.remote_ip, Loco’s RemoteIP). It is RemoteIp(None) only when the header is missing or malformed, e.g. in unit tests that build requests by hand. Never rejects. Use it to key rate limits or to record where a sign-in came from; it is personal data under the GDPR.

Examples

use ocre::RemoteIp;

async fn whoami(RemoteIp(ip): RemoteIp) -> String {
    ip.map_or_else(|| "unknown".to_owned(), |ip| ip.to_string())
}

Tuple Fields

0: Option<IpAddr>

Trait Implementations

impl Clone for RemoteIp

fn clone(&self) -> RemoteIp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RemoteIp

impl Debug for RemoteIp

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

Formats the value using the given formatter.

impl Eq for RemoteIp

impl<S: Send + Sync> FromRequestParts<S> for RemoteIp

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

impl PartialEq for RemoteIp

fn eq(&self, other: &RemoteIp) -> 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 RemoteIp