pub struct Forwarded<'a> { /* private fields */ }
Expand description
A rust representation of the forwarded header.
Implementations
impl<'a> Forwarded<'a>
impl<'a> Forwarded<'a>
pub fn from_headers(
headers: &'a impl AsRef<Headers>
) -> Result<Option<Forwarded<'a>>, ParseError>
pub fn from_headers(
headers: &'a impl AsRef<Headers>
) -> Result<Option<Forwarded<'a>>, 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
let mut request = Request::new(Get, Url::parse("http://_/")?);
request.insert_header(
"Forwarded",
r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
let forwarded = Forwarded::from_headers(&request)?.unwrap();
assert_eq!(forwarded.proto(), Some("https"));
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]", "unknown"]);
let mut request = Request::new(Get, Url::parse("http://_/")?);
request.insert_header("X-Forwarded-For", "192.0.2.43, 2001:db8:cafe::17, unknown");
request.insert_header("X-Forwarded-Proto", "https");
let forwarded = Forwarded::from_headers(&request)?.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.value()?,
r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
pub fn from_forwarded_header(
headers: &'a impl AsRef<Headers>
) -> Result<Option<Forwarded<'a>>, ParseError>
pub fn from_forwarded_header(
headers: &'a impl AsRef<Headers>
) -> Result<Option<Forwarded<'a>>, ParseError>
Parse a borrowed Forwarded from the Forwarded header, without x-forwarded-{for,by,proto} fallback
Examples
let mut request = Request::new(Get, Url::parse("http://_/")?);
request.insert_header(
"Forwarded",
r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
let forwarded = Forwarded::from_forwarded_header(&request)?.unwrap();
assert_eq!(forwarded.proto(), Some("https"));
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]", "unknown"]);
let mut request = Request::new(Get, Url::parse("http://_/")?);
request.insert_header("X-Forwarded-For", "192.0.2.43, 2001:db8:cafe::17");
assert!(Forwarded::from_forwarded_header(&request)?.is_none());
pub fn from_x_headers(
headers: &'a impl AsRef<Headers>
) -> Result<Option<Forwarded<'a>>, ParseError>
pub fn from_x_headers(
headers: &'a impl AsRef<Headers>
) -> Result<Option<Forwarded<'a>>, 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 request = Request::new(Get, Url::parse("http://_/")?);
request.insert_header("X-Forwarded-For", "192.0.2.43, 2001:db8:cafe::17");
let forwarded = Forwarded::from_headers(&request)?.unwrap();
assert_eq!(forwarded.forwarded_for(), vec!["192.0.2.43", "[2001:db8:cafe::17]"]);
let mut request = Request::new(Get, Url::parse("http://_/")?);
request.insert_header(
"Forwarded",
r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
assert!(Forwarded::from_x_headers(&request)?.is_none());
pub fn parse(input: &'a str) -> Result<Forwarded<'a>, ParseError>
pub fn parse(input: &'a str) -> Result<Forwarded<'a>, 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.value()?,
r#"for=192.0.2.43, for="[2001:db8:cafe::17]", for=unknown;proto=https"#
);
pub fn into_owned(self) -> Forwarded<'static>
pub fn into_owned(self) -> Forwarded<'static>
Transform a borrowed Forwarded into an owned Forwarded. This is a noop if the Forwarded is already owned.
pub fn apply(&self, headers: impl AsMut<Headers>)
pub fn apply(&self, headers: impl AsMut<Headers>)
Insert a header that represents this Forwarded.
Example
let mut response = http_types::Response::new(200);
let mut forwarded = http_types::proxies::Forwarded::new();
forwarded.add_for("192.0.2.43");
forwarded.add_for("[2001:db8:cafe::17]");
forwarded.set_proto("https");
forwarded.apply(&mut response);
assert_eq!(response["Forwarded"], r#"for=192.0.2.43, for="[2001:db8:cafe::17]";proto=https"#);
pub fn value(&self) -> Result<String, Error>
pub fn value(&self) -> Result<String, Error>
Builds a Forwarded header as a String.
Example
let mut forwarded = http_types::proxies::Forwarded::new();
forwarded.add_for("_haproxy");
forwarded.add_for("[2001:db8:cafe::17]");
forwarded.set_proto("https");
assert_eq!(forwarded.value()?, r#"for=_haproxy, for="[2001:db8:cafe::17]";proto=https"#);
pub fn forwarded_for(&self) -> Vec<&str, Global>
pub fn forwarded_for(&self) -> Vec<&str, Global>
Returns the for
field of this header
Trait Implementations
impl<'_> ToHeaderValues for Forwarded<'_>
impl<'_> ToHeaderValues for Forwarded<'_>
type Iter = IntoIter<HeaderValue>
type Iter = IntoIter<HeaderValue>
Returned iterator over header values which this type may correspond to.
fn to_header_values(
&self
) -> Result<<Forwarded<'_> as ToHeaderValues>::Iter, Error>
fn to_header_values(
&self
) -> Result<<Forwarded<'_> as ToHeaderValues>::Iter, Error>
Converts this object to an iterator of resolved HeaderValues
.
impl<'_, '_> ToHeaderValues for &'_ Forwarded<'_>
impl<'_, '_> ToHeaderValues for &'_ Forwarded<'_>
type Iter = IntoIter<HeaderValue>
type Iter = IntoIter<HeaderValue>
Returned iterator over header values which this type may correspond to.
fn to_header_values(
&self
) -> Result<<&'_ Forwarded<'_> as ToHeaderValues>::Iter, Error>
fn to_header_values(
&self
) -> Result<<&'_ Forwarded<'_> as ToHeaderValues>::Iter, Error>
Converts this object to an iterator of resolved HeaderValues
.
impl<'a> Eq for Forwarded<'a>
impl<'a> StructuralEq for Forwarded<'a>
impl<'a> StructuralPartialEq for Forwarded<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for Forwarded<'a>
impl<'a> Send for Forwarded<'a>
impl<'a> Sync for Forwarded<'a>
impl<'a> Unpin for Forwarded<'a>
impl<'a> UnwindSafe for Forwarded<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more