Struct TrustedProxies 

pub struct TrustedProxies { /* private fields */ }

Reverse proxies whose forwarding header is believed, and which header that is.

Empty by default: the client IP is then always the TCP peer. Behind a reverse proxy, list its address (or range), otherwise every client shares the proxy’s bucket. Only the configured ClientIpHeader is read, X-Forwarded-For unless TrustedProxies::with_header says otherwise.

Parsed from a comma-separated list of IP addresses and CIDR ranges.

Examples

use ironflow_api::rate_limit::TrustedProxies;

let proxies: TrustedProxies = "10.0.0.0/8, 192.168.1.10".parse()?;
assert!(proxies.contains("10.1.2.3".parse()?));
assert!(proxies.contains("192.168.1.10".parse()?));
assert!(!proxies.contains("203.0.113.7".parse()?));
assert!(TrustedProxies::default().is_empty());

Implementations

impl TrustedProxies

pub fn contains(&self, ip: IpAddr) -> bool

Whether ip belongs to one of the trusted proxies.

An IPv4-mapped IPv6 address (::ffff:10.0.0.1) matches its IPv4 form.

Examples

use ironflow_api::rate_limit::TrustedProxies;

let proxies: TrustedProxies = "10.0.0.1".parse()?;
assert!(proxies.contains("::ffff:10.0.0.1".parse()?));

pub fn is_empty(&self) -> bool

Whether no proxy is trusted.

Examples

use ironflow_api::rate_limit::TrustedProxies;

assert!(TrustedProxies::default().is_empty());

pub fn with_header(self, header: ClientIpHeader) -> Self

Read the client IP from header instead of the default X-Forwarded-For.

Examples

use ironflow_api::rate_limit::{ClientIpHeader, TrustedProxies};

let proxies = "10.0.0.1"
    .parse::<TrustedProxies>()?
    .with_header(ClientIpHeader::XRealIp);
assert_eq!(proxies.header(), ClientIpHeader::XRealIp);

pub fn header(&self) -> ClientIpHeader

The forwarding header read from a trusted proxy.

Examples

use ironflow_api::rate_limit::{ClientIpHeader, TrustedProxies};

assert_eq!(TrustedProxies::default().header(), ClientIpHeader::XForwardedFor);

Trait Implementations

impl Clone for TrustedProxies

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrustedProxies

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

Formats the value using the given formatter.

impl Default for TrustedProxies

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TrustedProxies

impl FromStr for TrustedProxies

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a comma-separated list. Blank entries are skipped, so an empty string trusts no proxy.

type Err = InvalidTrustedProxy

The associated error which can be returned from parsing.

impl PartialEq for TrustedProxies

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TrustedProxies