Struct ClientIp 

#[repr(transparent)]
pub struct ClientIp<F: Filter> {
    pub inner: Option<IpAddr>,
    /* private fields */
}

ClientIp extractor

Provided F parameter can be used to customize filter selection. Use nil type to only extract rightmost IP.

Defaults to axum::extract::ConnectInfo if corresponding header cannot provide ip

Usage

use std::net::{IpAddr, Ipv4Addr};

use http_ip::axum08::{
    routing::get,
    handler::Handler,
    Router,
};
use http_ip::axum08::ClientIp;

#[derive(Clone)]
struct MyState {
    local_ip: IpAddr,
}

impl http_ip::axum08::extract::FromRef<MyState> for IpAddr {
    #[inline(always)]
    fn from_ref(state: &MyState) -> Self {
        state.local_ip
    }
}

async fn create_user(client_ip: ClientIp<IpAddr>) {
    // Do whatever you want with client_ip now
}

let state = MyState {
    local_ip: IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1))
};
let app: Router<MyState> = Router::new().route("/users", get(create_user)).with_state(state);

Fields

inner: Option<IpAddr>

Underlying IP addr if available

Implementations

impl<F: Filter> ClientIp<F>

pub fn into_inner(self) -> Option<IpAddr>

Access underlying value

Trait Implementations

impl<F: Clone + Filter> Clone for ClientIp<F>

fn clone(&self) -> ClientIp<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Filter> Debug for ClientIp<F>

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

Formats the value using the given formatter.

impl<S: Send + Sync, F: Send + Sync + Filter + Clone + FromRef<S>> FromRequestParts<S> for ClientIp<F>

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<F: Copy + Filter> Copy for ClientIp<F>