Struct actix_web_lab::header::Forwarded

pub struct Forwarded { /* private fields */ }

Forwarded header, defined in RFC 7239.

Also see the Forwarded header’s MDN docs for field semantics.

Implementations

impl Forwarded

pub fn new( by: impl Into<Option<String>>, for: impl Into<Vec<String>>, host: impl Into<Option<String>>, proto: impl Into<Option<String>>, ) -> Self

Constructs new Forwarded header from parts.

pub fn new_for(for: impl Into<String>) -> Self

Constructs new Forwarded header from a single “for” identifier.

pub fn for_client(&self) -> Option<&str>

Returns first “for” parameter which is typically the client’s identifier.

pub fn for_chain(&self) -> impl Iterator<Item = &str>

Returns iterator over the “for” chain.

The first item yielded will match for_client and the rest will be proxy identifiers, in the order the request passed through them.

pub fn by(&self) -> Option<&str>

Returns the “by” identifier, if set.

The interface where the request came in to the proxy server.

pub fn host(&self) -> Option<&str>

Returns the “host” identifier, if set.

Should equal the Host request header field as received by the proxy.

pub fn proto(&self) -> Option<&str>

Returns the “proto” identifier, if set.

Indicates which protocol was used to make the request (typically “http” or “https”).

pub fn push_for(&mut self, identifier: impl Into<String>)

Adds an identifier to the “for” chain.

Useful when re-forwarding a request and needing to update the request headers with previous proxy’s address.

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

Formats the value using the given formatter.

impl FromStr for Forwarded

type Err = Infallible

The associated error which can be returned from parsing.

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

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

impl Header for Forwarded

fn name() -> HeaderName

Returns the name of the header field.

fn parse<M: HttpMessage>(msg: &M) -> Result<Self, ParseError>

Parse the header from a HTTP message.

impl Ord for Forwarded

fn cmp(&self, other: &Forwarded) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Forwarded

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Forwarded

fn partial_cmp(&self, other: &Forwarded) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryIntoHeaderValue for Forwarded

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.

impl Eq for Forwarded

impl StructuralPartialEq for Forwarded