Struct actix_web_lab::header::XForwardedPrefix

pub struct XForwardedPrefix(pub PathAndQuery);

The X-Forwarded-Prefix header, defined in [RFC XXX §X.X].

The X-Forwarded-Prefix header field is used

Also see

Example Values

• /
• /foo

Examples

use actix_web::HttpResponse;
use actix_web_lab::header::XForwardedPrefix;

let mut builder = HttpResponse::Ok();
builder.insert_header(XForwardedPrefix("/bar".parse().unwrap()));

Tuple Fields

0: PathAndQuery

Methods from Deref<Target = PathAndQuery>

pub fn path(&self) -> &str

Returns the path component

The path component is case sensitive.

abc://username:password@example.com:123/path/data?key=value&key2=value2#fragid1
                                       |--------|
                                            |
                                          path

If the URI is * then the path component is equal to *.

Examples

let path_and_query: PathAndQuery = "/hello/world".parse().unwrap();

assert_eq!(path_and_query.path(), "/hello/world");

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

Returns the query string component

The query component contains non-hierarchical data that, along with data in the path component, serves to identify a resource within the scope of the URI’s scheme and naming authority (if any). The query component is indicated by the first question mark (“?”) character and terminated by a number sign (“#”) character or by the end of the URI.

abc://username:password@example.com:123/path/data?key=value&key2=value2#fragid1
                                                  |-------------------|
                                                            |
                                                          query

Examples

With a query string component

let path_and_query: PathAndQuery = "/hello/world?key=value&foo=bar".parse().unwrap();

assert_eq!(path_and_query.query(), Some("key=value&foo=bar"));

Without a query string component

let path_and_query: PathAndQuery = "/hello/world".parse().unwrap();

assert!(path_and_query.query().is_none());

pub fn as_str(&self) -> &str

Returns the path and query as a string component.

Examples

With a query string component

let path_and_query: PathAndQuery = "/hello/world?key=value&foo=bar".parse().unwrap();

assert_eq!(path_and_query.as_str(), "/hello/world?key=value&foo=bar");

Without a query string component

let path_and_query: PathAndQuery = "/hello/world".parse().unwrap();

assert_eq!(path_and_query.as_str(), "/hello/world");

Trait Implementations

impl Clone for XForwardedPrefix

fn clone(&self) -> XForwardedPrefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XForwardedPrefix

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

Formats the value using the given formatter.

impl Deref for XForwardedPrefix

type Target = PathAndQuery

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for XForwardedPrefix

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for XForwardedPrefix

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

Formats the value using the given formatter.

impl Header for XForwardedPrefix

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

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

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 XForwardedPrefix

impl StructuralPartialEq for XForwardedPrefix