Struct forwarded_header_value::ForwardedHeaderValue

pub struct ForwardedHeaderValue { /* private fields */ }

This structure represents the contents of the Forwarded header

It should contain one or more ForwardedStanzas

Implementations

impl ForwardedHeaderValue

pub fn len(&self) -> usize

The number of valid stanzas in this value

pub fn is_empty(&self) -> bool

This can never be empty

pub fn remotest(&self) -> &ForwardedStanza

Get the value farthest from this system (the left-most value)

This may represent the remote client

pub fn into_remotest(self) -> ForwardedStanza

Get the value farthest from this system (the left-most value), consuming this object

This may represent the remote client

pub fn proximate(&self) -> &ForwardedStanza

Get the value closest to this system (the right-most value).

This is typically the only trusted value in a well-architected system.

pub fn into_proximate(self) -> ForwardedStanza

Get the value closest to this system (the right-most value), consuming this object

This is typically the only trusted value in a well-architected system.

pub fn iter(&self) -> ForwardedHeaderValueIterator<'_>

Iterate through all ForwardedStanzas

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

Return the rightmost non-empty forwarded-for IP, if one is present

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

Return the leftmost forwarded-for IP, if one is present

pub fn from_forwarded( header_value: &str, ) -> Result<Self, ForwardedHeaderValueParseError>

Parse the value from a Forwarded header into this structure

Example

let input = "for=1.2.3.4;by=\"[::1]:1234\"";
let value = ForwardedHeaderValue::from_forwarded(input)?;
assert_eq!(value.len(), 1);
assert_eq!(value.remotest_forwarded_for_ip(), Some("1.2.3.4".parse()?));

pub fn from_x_forwarded_for( header_value: &str, ) -> Result<Self, ForwardedHeaderValueParseError>

Parse the value from an X-Forwarded-For header into this structure

Example

let input = "1.2.3.4, 5.6.7.8";
let value = ForwardedHeaderValue::from_x_forwarded_for(input)?;
assert_eq!(value.len(), 2);
assert_eq!(value.remotest_forwarded_for_ip(), Some("1.2.3.4".parse()?));
assert_eq!(value.proximate_forwarded_for_ip(), Some("5.6.7.8".parse()?));

Trait Implementations

impl Debug for ForwardedHeaderValue

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

Formats the value using the given formatter.

impl FromStr for ForwardedHeaderValue

type Err = ForwardedHeaderValueParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl IntoIterator for ForwardedHeaderValue

type Item = ForwardedStanza

The type of the elements being iterated over.

type IntoIter = Chain<Once<<ForwardedHeaderValue as IntoIterator>::Item>, IntoIter<<ForwardedHeaderValue as IntoIterator>::Item>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.