Struct trillium_forwarding::Forwarded

source ·

pub struct Forwarded<'a> { /* private fields */ }

Expand description

A rust representation of the forwarded header.

Implementations§

source §

impl<'a> Forwarded<'a>

source

pub fn from_headers(headers: &'a Headers) -> Result<Option<Self>, ParseError>

Attempts to parse a Forwarded from headers (or a request or response). Builds a borrowed Forwarded by default. To build an owned Forwarded, use Forwarded::from_headers(...).into_owned()

§X-Forwarded-For, -By, and -Proto compatability

This implementation includes fall-back support for the historical unstandardized headers x-forwarded-for, x-forwarded-by, and x-forwarded-proto. If you do not wish to support these headers, use Forwarded::from_forwarded_header. To only support these historical headers and not the standardized Forwarded header, use Forwarded::from_x_headers.

Please note that either way, this implementation will normalize to the standardized Forwarded header, as recommended in rfc7239§7.4

§Examples

use trillium_forwarding::Forwarded;

let mut headers = Headers::new();
headers.insert(
    "Forwarded",
    r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
let forwarded = Forwarded::from_headers(&headers)?.unwrap();
assert_eq!(forwarded.proto(), Some("https"));
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]", "unknown"]);

let mut headers = Headers::new();
headers.insert("X-Forwarded-For", "192.0.2.43, 2001:db8:cafe::17, unknown");
headers.insert("X-Forwarded-Proto", "https");
let forwarded = Forwarded::from_headers(&headers)?.unwrap();
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]", "unknown"]);
assert_eq!(forwarded.proto(), Some("https"));
assert_eq!(
    forwarded.to_string(),
    r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);

source

pub fn from_forwarded_header( headers: &'a Headers, ) -> Result<Option<Self>, ParseError>

Parse a borrowed Forwarded from the Forwarded header, without x-forwarded-{for,by,proto} fallback

§Examples

let mut headers = Headers::new();
headers.insert(
    "Forwarded",
    r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
let forwarded = Forwarded::from_forwarded_header(&headers)?.unwrap();
assert_eq!(forwarded.proto(), Some("https"));
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]", "unknown"]);

let mut headers = Headers::new();
headers.insert("X-Forwarded-For", "192.0.2.43, 2001:db8:cafe::17");
assert!(Forwarded::from_forwarded_header(&headers)?.is_none());

source

pub fn from_x_headers(headers: &'a Headers) -> Result<Option<Self>, ParseError>

Parse a borrowed Forwarded from the historical non-standardized x-forwarded-{for,by,proto} headers, without support for the Forwarded header.

§Examples

let mut headers = Headers::new();
headers.insert("X-Forwarded-For", "192.0.2.43, 2001:db8:cafe::17");
let forwarded = Forwarded::from_headers(&headers)?.unwrap();
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]"]);

let mut headers = Headers::new();
headers.insert(
    "Forwarded",
    r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
assert!(Forwarded::from_x_headers(&headers)?.is_none());

source

pub fn parse(input: &'a str) -> Result<Self, ParseError>

parse a &str into a borrowed Forwarded

§Examples


let forwarded = Forwarded::parse(
    r#"for=192.0.2.43,         for="[2001:db8:cafe::17]", FOR=unknown;proto=https"#
)?;
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]", "unknown"]);
assert_eq!(
    forwarded.to_string(),
    r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);