Struct XForwardedHost

pub struct XForwardedHost(/* private fields */);

The X-Forwarded-Host (XFH) header is a de-facto standard header for identifying the original host requested by the client in the Host HTTP request header.

It is recommended to use the Forwarded header instead if you can.

More info can be found at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host.

Syntax

X-Forwarded-Host: <host>

Example values

• id42.example-cdn.com
• id42.example-cdn.com:443
• 203.0.113.195
• 203.0.113.195:80
• 2001:db8:85a3:8d3:1319:8a2e:370:7348
• [2001:db8:85a3:8d3:1319:8a2e:370:7348]:8080

Implementations

impl XForwardedHost

pub fn host(&self) -> &Host

Get a reference to the Host of this XForwardedHost.

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

Get a copy of the port of this XForwardedHost if it is set.

pub fn inner(&self) -> &ForwardedAuthority

Return a reference to the inner data of this Header.

pub fn into_inner(self) -> ForwardedAuthority

Consume this Header into its inner data.

Trait Implementations

impl Clone for XForwardedHost

fn clone(&self) -> XForwardedHost

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XForwardedHost

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

Formats the value using the given formatter.

impl ForwardHeader for XForwardedHost

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

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

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

impl Header for XForwardedHost

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I: Iterator<Item = &'i HeaderValue>>( values: &mut I, ) -> Result<Self, Error>

Decode this type from an iterator of HeaderValues.

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

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> HeaderValue

Encode this Header to HeaderValue.

impl IntoIterator for XForwardedHost

type Item = ForwardedElement

The type of the elements being iterated over.

type IntoIter = XForwardedHostIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for XForwardedHost

fn eq(&self, other: &XForwardedHost) -> 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 Eq for XForwardedHost

impl StructuralPartialEq for XForwardedHost