Struct Forwarded 

pub struct Forwarded { /* private fields */ }

Available on crate feature net only.

Forwarding information stored as a chain.

This extension (which can be stored and modified via the Extensions) allows to keep track of the forward information. E.g. what was the original host used by the user, by which proxy it was forwarded, what was the intended protocol (e.g. https), etc…

RFC: https://datatracker.ietf.org/doc/html/rfc7239

Implementations

impl Forwarded

pub const fn new(element: ForwardedElement) -> Forwarded

Create a new Forwarded extension for the given ForwardedElement, the first (client-most) element of the chain.

pub fn client( &self, policy: &ForwardedSelectionPolicy, ) -> Option<&ForwardedElement>

The element describing the client, per policy.

pub fn record( extensions: &Extensions, elements: impl IntoIterator<Item = ForwardedElement>, )

Record the elements a source of forwarding information found into the chain of extensions.

Sources are read from the nearest hop outwards, such as a PROXY protocol header before the HTTP headers it carries, so these elements go before those recorded already.

pub fn prepend( &mut self, farther: impl IntoIterator<Item = ForwardedElement>, ) -> &mut Forwarded

Prepend elements written by hops farther away than this chain’s, keeping their order.

pub fn append(&mut self, element: ForwardedElement) -> &mut Forwarded

Append a ForwardedElement to this Forwarded context.

pub fn extend( &mut self, elements: impl IntoIterator<Item = ForwardedElement>, ) -> &mut Forwarded

Extend this Forwarded context with the given ForwardedElements.

pub fn iter(&self) -> impl DoubleEndedIterator

Iterate over the ForwardedElements in this Forwarded context.

Trait Implementations

impl Clone for Forwarded

fn clone(&self) -> Forwarded

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Forwarded

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

Formats the value using the given formatter.

impl Display for Forwarded

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

Formats the value using the given formatter.

impl Eq for Forwarded

impl Extension for Forwarded

impl From<Forwarded> for Forwarded

fn from(value: Forwarded) -> Forwarded

Converts to this type from the input type.

impl From<Forwarded> for Forwarded

fn from(value: Forwarded) -> Forwarded

Converts to this type from the input type.

impl From<ForwardedElement> for Forwarded

fn from(value: ForwardedElement) -> Forwarded

Converts to this type from the input type.

impl FromStr for Forwarded

type Err = Box<dyn Error + Sync + Send>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Forwarded, <Forwarded as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoIterator for Forwarded

type Item = ForwardedElement

The type of the elements being iterated over.

type IntoIter = Chain<Once<ForwardedElement>, IntoIter<ForwardedElement>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Forwarded as IntoIterator>::IntoIter

Creates an iterator from a value.

impl NetExtension for Forwarded

impl PartialEq for Forwarded

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Forwarded

impl TryFrom<&[u8]> for Forwarded

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( bytes: &[u8], ) -> Result<Forwarded, <Forwarded as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&str> for Forwarded

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Forwarded, <Forwarded as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for Forwarded

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<Forwarded, <Forwarded as TryFrom<String>>::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Forwarded

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( bytes: Vec<u8>, ) -> Result<Forwarded, <Forwarded as TryFrom<Vec<u8>>>::Error>

Performs the conversion.