Struct ForwardedSelectionPolicy 

pub struct ForwardedSelectionPolicy { /* private fields */ }

Available on crate feature net only.

Selects which element of a Forwarded chain describes the client.

A chain lists the client-most hop first and the hop nearest to this service last (RFC 7239 §4). Only what a trusted proxy wrote can be relied on (RFC 7239 §8.1), and a proxy appending to a header the client sent keeps the client’s own claim in front, so the default counts from the right, as nginx, Envoy, HAProxy, ASP.NET Core and Rails do.

Elements whose for address is a trusted proxy are skipped, then hops more are, counting from the side. Without a remaining element there is no client, and callers fall back to the connection.

It is an extension of its own, read by every consumer of Forwarded client information (see ForwardedClientExt); layers that record forwarding information can install it.

Implementations

impl ForwardedSelectionPolicy

pub fn new() -> ForwardedSelectionPolicy

The rightmost element, without skipping any.

pub fn with_side(self, side: ForwardedSide) -> ForwardedSelectionPolicy

The end of the chain to count from.

pub fn set_side(&mut self, side: ForwardedSide) -> &mut ForwardedSelectionPolicy

The end of the chain to count from.

pub fn with_hops(self, hops: usize) -> ForwardedSelectionPolicy

Elements to skip from the side, such as 1 behind two trusted proxies that each append.

pub fn set_hops(&mut self, hops: usize) -> &mut ForwardedSelectionPolicy

Elements to skip from the side, such as 1 behind two trusted proxies that each append.

pub fn with_trusted_proxies( self, proxies: impl IntoIterator<Item = IpNet>, ) -> ForwardedSelectionPolicy

Skip the elements whose for address is one of these proxies.

pub fn set_trusted_proxies( &mut self, proxies: impl IntoIterator<Item = IpNet>, ) -> &mut ForwardedSelectionPolicy

Skip the elements whose for address is one of these proxies.

pub fn install( self: &Arc<ForwardedSelectionPolicy>, extensions: &Extensions, keep_existing: bool, )

Install this shared policy in extensions, unless keep_existing and one is set already.

pub fn select<'a>( &self, forwarded: &'a Forwarded, ) -> Option<&'a ForwardedElement>

The element of forwarded describing the client, if any remains.

Trait Implementations

impl Clone for ForwardedSelectionPolicy

fn clone(&self) -> ForwardedSelectionPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForwardedSelectionPolicy

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

Formats the value using the given formatter.

impl Default for ForwardedSelectionPolicy

fn default() -> ForwardedSelectionPolicy

Returns the “default value” for a type.

impl Eq for ForwardedSelectionPolicy

impl Extension for ForwardedSelectionPolicy

impl NetExtension for ForwardedSelectionPolicy

impl PartialEq for ForwardedSelectionPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ForwardedSelectionPolicy