Struct Forwarded

pub struct Forwarded { /* private fields */ }

Forwarding information stored as a chain.

This extension (which can be stored and modified via the Context) 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 as the client Element (the first element).

pub fn client_host(&self) -> Option<&ForwardedAuthority>

Return the client host of this Forwarded context, if there is one defined.

It is assumed that only the first element can be described as client information.

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

Return the client SocketAddr of this Forwarded context, if both an Ip and a port are defined.

You can try to fallback to Self::client_ip, in case this method returns None.

pub fn client_port(&self) -> Option<u16>

Return the client port of this Forwarded context, if there is one defined.

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

Return the client Ip of this Forwarded context, if there is one defined.

This method may return None because there is no forwarded “for” information for the client element or because the IP is obfuscated.

It is assumed that only the first element can be described as client information.

pub fn client_proto(&self) -> Option<ForwardedProtocol>

Return the client protocol of this Forwarded context, if there is one defined.

pub fn client_version(&self) -> Option<ForwardedVersion>

Return the client protocol version of this Forwarded context, if there is one defined.

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 Iterator<Item = &ForwardedElement>

Iterate over the ForwardedElements in this Forwarded context.

Trait Implementations

impl Clone for Forwarded

fn clone(&self) -> Forwarded

Returns a copy 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 ForwardHeader for Forwarded

fn try_from_forwarded<'a, I>(input: I) -> Option<Forwarded>

where I: IntoIterator<Item = &'a ForwardedElement>,

Try to convert the given iterator of ForwardedElement into the header.

impl From<ForwardedElement> for Forwarded

fn from(value: ForwardedElement) -> Forwarded

Converts to this type from the input type.

impl FromStr for Forwarded

type Err = OpaqueError

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 Header for Forwarded

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I>(values: &mut I) -> Result<Forwarded, Error>

where Forwarded: Sized, I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderMap.

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 PartialEq for Forwarded

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for Forwarded

type Error = OpaqueError

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<&HeaderValue> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from( header: &HeaderValue, ) -> Result<Forwarded, <Forwarded as TryFrom<&HeaderValue>>::Error>

Performs the conversion.

impl TryFrom<&str> for Forwarded

type Error = OpaqueError

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<HeaderValue> for Forwarded

type Error = OpaqueError

The type returned in the event of a conversion error.

fn try_from( header: HeaderValue, ) -> Result<Forwarded, <Forwarded as TryFrom<HeaderValue>>::Error>

Performs the conversion.

impl TryFrom<String> for Forwarded

type Error = OpaqueError

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 = OpaqueError

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.

impl Eq for Forwarded

impl StructuralPartialEq for Forwarded