Struct ClientAddress 

pub struct ClientAddress { /* private fields */ }

The client address the proxy resolved for a request.

A request extension on every request the proxy serves: an AuthDecider and an ExtraRouteHandler get it in their request view, a fallback and a tonic upstream in process read it with request.extensions().get::<ClientAddress>(). The connection’s own record (Request::remote_addr, Request::peer_certs) stays as it is.

Examples

use structured_proxy::client_address::{ClientAddress, Resolution};

// What a tonic handler behind the proxy does with it.
fn caller(request: &tonic::Request<()>) -> Option<std::net::IpAddr> {
    request.extensions().get::<ClientAddress>()?.ip()
}

let client = ClientAddress::from_peer(Some("203.0.113.7:51234".parse().unwrap()));
assert_eq!(client.resolution(), Resolution::Peer("203.0.113.7".parse().unwrap()));
let mut request = tonic::Request::new(());
request.extensions_mut().insert(client);
assert_eq!(caller(&request), Some("203.0.113.7".parse().unwrap()));

Implementations

impl ClientAddress

pub fn from_peer(peer: Option<SocketAddr>) -> Self

The address of a request from peer through no trusted proxy: the peer itself, or Resolution::Unavailable without one. The view a hook’s own tests hand it.

pub fn ip(&self) -> Option<IpAddr>

The client’s address, when one resolved.

pub fn peer(&self) -> Option<SocketAddr>

The connection’s peer: the client, or the last proxy before this one.

pub fn resolution(&self) -> Resolution

How the address was resolved, or why it was not.

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 Debug for ClientAddress

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

Formats the value using the given formatter.

impl Eq for ClientAddress

impl PartialEq for ClientAddress

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientAddress