Struct ClientIp 

pub struct ClientIp(pub IpAddr);

Client IP address extractor

Extracts the client IP address from the request. When trust_proxy is enabled, it will use the X-Forwarded-For header if present.

Example

use rustapi_core::extract::ClientIp;

async fn handler(ClientIp(ip): ClientIp) -> impl IntoResponse {
    format!("Your IP: {}", ip)
}

Tuple Fields

0: IpAddr

Implementations

impl ClientIp

pub fn extract_with_config( req: &Request, trust_proxy: bool, ) -> Result<ClientIp, ApiError>

Extract client IP, optionally trusting X-Forwarded-For header

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<(), Error>

Formats the value using the given formatter.

impl FromRequestParts for ClientIp

fn from_request_parts(req: &Request) -> Result<ClientIp, ApiError>

Extract from request parts