Enum ClientAddress 

#[non_exhaustive]
pub enum ClientAddress {
    Peer(IpAddr),
    Forwarded {
        addr: IpAddr,
        hops: u8,
    },
    Unknown {
        hops: u8,
    },
}

The client address a request is attributed to.

Examples

use core::net::IpAddr;
use parse_net::{client_address, ClientAddress, ForwardedSource};

let peer: IpAddr = "10.0.0.1".parse()?;
let trusted = |a: IpAddr| a == peer;
let hidden: [&[u8]; 1] = [b"for=unknown"];
assert_eq!(client_address(peer, ForwardedSource::Forwarded(&hidden), &trusted, 16)?, ClientAddress::Unknown { hops: 1 });
let none: [&[u8]; 0] = [];
assert_eq!(client_address(peer, ForwardedSource::XForwardedFor(&none), &trusted, 16)?, ClientAddress::Peer(peer));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Peer(IpAddr)

The connection’s peer: it is not a trusted proxy (its header was not read), or it is a trusted proxy that forwarded no chain.

Forwarded

An address from the chain, found after walking hops elements from the right.

Fields

addr: IpAddr

The client address.

hops: u8

The elements walked, the returned one included.

Unknown

The walk reached unknown, an obfuscated identifier, or an element without for after hops elements: nothing to its left can be trusted.

Fields

hops: u8

The elements walked, the unknown one included.

Trait Implementations

impl Clone for ClientAddress

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClientAddress

impl Debug for ClientAddress

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

Formats the value using the given formatter.

impl Eq for ClientAddress

impl Hash for ClientAddress

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClientAddress

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientAddress