Struct ClientIpConfig 

pub struct ClientIpConfig { /* private fields */ }

Available on crate feature server only.

Config for extract client ip

Implementations

impl ClientIpConfig

pub fn new() -> Self

Create a new ClientIpConfig with default values

default remote ip headers: ["X-Real-IP", "X-Forwarded-For"]

default trusted cidrs: ["0.0.0.0/0", "::/0"]

pub fn with_remote_ip_headers<I>( self, headers: I, ) -> Result<Self, InvalidHeaderName>

where I: IntoIterator, I::Item: AsRef<str>,

Get Real Client IP by parsing the given headers.

See ClientIp for more details.

Example

use volo_http::server::utils::client_ip::ClientIpConfig;

let client_ip_config =
    ClientIpConfig::new().with_remote_ip_headers(vec!["X-Real-IP", "X-Forwarded-For"]);

pub fn with_trusted_cidrs<H>(self, cidrs: H) -> Self

where H: IntoIterator<Item = IpNet>,

Get Real Client IP if it is trusted, otherwise it will just return caller ip.

See ClientIp for more details.

Example

use volo_http::server::utils::client_ip::ClientIpConfig;

let client_ip_config = ClientIpConfig::new()
    .with_trusted_cidrs(vec!["0.0.0.0/0".parse().unwrap(), "::/0".parse().unwrap()]);

Trait Implementations

impl Clone for ClientIpConfig

fn clone(&self) -> ClientIpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientIpConfig

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

Formats the value using the given formatter.

impl Default for ClientIpConfig

fn default() -> Self

Returns the “default value” for a type.