Struct XForwardedFor

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

The X-Forwarded-For (XFF) request header is a de-facto standard header for identifying the originating IP address of a client connecting to a web server through a proxy server.

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-For.

Syntax

X-Forwarded-For: <client>, <proxy1>, <proxy2>

Example values

• 2001:db8:85a3:8d3:1319:8a2e:370:7348
• 203.0.113.195
• 203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178

Implementations

impl XForwardedFor

pub fn iter(&self) -> impl Iterator<Item = &IpAddr>

Returns an iterator over the defined IpAddr.

Trait Implementations

impl Clone for XForwardedFor

fn clone(&self) -> XForwardedFor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XForwardedFor

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

Formats the value using the given formatter.

impl ForwardHeader for XForwardedFor

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

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

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

impl FromIterator<IpAddr> for XForwardedFor

fn from_iter<T>(iter: T) -> XForwardedFor

where T: IntoIterator<Item = IpAddr>,

Creates a value from an iterator.

impl HeaderDecode for XForwardedFor

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for XForwardedFor

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

where E: Extend<HeaderValue>,

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 XForwardedFor

type Item = ForwardedElement

The type of the elements being iterated over.

type IntoIter = XForwardedForIterator

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl PartialEq for XForwardedFor

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

fn name() -> &'static HeaderName

The name of this header.

impl Eq for XForwardedFor

impl StructuralPartialEq for XForwardedFor