Struct rama::http::layer::forwarded::GetForwardedHeadersLayer
pub struct GetForwardedHeadersLayer<T = Forwarded> { /* private fields */ }
Expand description
Layer to extract Forwarded
information from the specified T
headers.
This layer can be used to extract the Forwarded
information from any specified header T
,
as long as the header implements the ForwardHeader
trait. Multiple headers can be specified
as a tuple, and the layer will extract information from them all, and combine the information.
Please take into consideration the following when combining headers:
- The last header in the tuple will take precedence over the previous headers, if the same information is present in multiple headers.
- Headers that can contain multiple elements, (e.g. X-Forwarded-For, Via) will combine their elements in the order as specified. That does however mean that in case one header has less elements then the other, that the combination down the line will not be accurate.
The following headers are supported by default:
GetForwardedHeadersLayer::forwarded
: The standardForwarded
headerRFC 7239
.GetForwardedHeadersLayer::via
: The canonicalVia
headerRFC 7230
.GetForwardedHeadersLayer::x_forwarded_for
: The canonical [X-Forwarded-For
] headerRFC 7239
.GetForwardedHeadersLayer::x_forwarded_host
: The canonical [X-Forwarded-Host
] headerRFC 7239
.GetForwardedHeadersLayer::x_forwarded_proto
: The canonical [X-Forwarded-Proto
] headerRFC 7239
.
Rama also has the following headers already implemented for you to use:
X-Real-Ip
,X-Client-Ip
,Client-Ip
,Cf-Connecting-Ip
andTrue-Client-Ip
.
There are no GetForwardedHeadersLayer
constructors for these headers,
but you can use the GetForwardedHeadersLayer::new
constructor and pass the header type as a type parameter,
alone or in a tuple with other headers.
§Example
This example shows you can extract the client IP from the X-Forwarded-For
header in case your application is behind a proxy which sets this header.
use rama_core::{
service::service_fn,
Context, Service, Layer,
};
use rama_http::{headers::Forwarded, layer::forwarded::GetForwardedHeadersLayer, Request};
use std::{convert::Infallible, net::IpAddr};
#[tokio::main]
async fn main() {
let service = GetForwardedHeadersLayer::x_forwarded_for()
.layer(service_fn(|ctx: Context<()>, _| async move {
let forwarded = ctx.get::<Forwarded>().unwrap();
assert_eq!(forwarded.client_ip(), Some(IpAddr::from([12, 23, 34, 45])));
assert!(forwarded.client_proto().is_none());
// ...
Ok::<_, Infallible>(())
}));
let req = Request::builder()
.header("X-Forwarded-For", "12.23.34.45")
.body(())
.unwrap();
service.serve(Context::default(), req).await.unwrap();
}
Implementations§
§impl<T> GetForwardedHeadersLayer<T>
impl<T> GetForwardedHeadersLayer<T>
pub const fn new() -> GetForwardedHeadersLayer<T>
pub const fn new() -> GetForwardedHeadersLayer<T>
Create a new GetForwardedHeadersLayer
for the specified headers T
.
§impl GetForwardedHeadersLayer
impl GetForwardedHeadersLayer
pub fn forwarded() -> GetForwardedHeadersLayer
pub fn forwarded() -> GetForwardedHeadersLayer
Create a new GetForwardedHeadersLayer
for the standard Forwarded
header.
§impl GetForwardedHeadersLayer<Via>
impl GetForwardedHeadersLayer<Via>
pub fn via() -> GetForwardedHeadersLayer<Via>
pub fn via() -> GetForwardedHeadersLayer<Via>
Create a new GetForwardedHeadersLayer
for the canonical Via
header.
§impl GetForwardedHeadersLayer<XForwardedFor>
impl GetForwardedHeadersLayer<XForwardedFor>
pub fn x_forwarded_for() -> GetForwardedHeadersLayer<XForwardedFor>
pub fn x_forwarded_for() -> GetForwardedHeadersLayer<XForwardedFor>
Create a new GetForwardedHeadersLayer
for the canonical [X-Forwarded-For
] header.
§impl GetForwardedHeadersLayer<XForwardedHost>
impl GetForwardedHeadersLayer<XForwardedHost>
pub fn x_forwarded_host() -> GetForwardedHeadersLayer<XForwardedHost>
pub fn x_forwarded_host() -> GetForwardedHeadersLayer<XForwardedHost>
Create a new GetForwardedHeadersLayer
for the canonical [X-Forwarded-Host
] header.
§impl GetForwardedHeadersLayer<XForwardedProto>
impl GetForwardedHeadersLayer<XForwardedProto>
pub fn x_forwarded_proto() -> GetForwardedHeadersLayer<XForwardedProto>
pub fn x_forwarded_proto() -> GetForwardedHeadersLayer<XForwardedProto>
Create a new GetForwardedHeadersLayer
for the canonical [X-Forwarded-Proto
] header.
Trait Implementations§
§impl<T> Clone for GetForwardedHeadersLayer<T>where
T: Clone,
impl<T> Clone for GetForwardedHeadersLayer<T>where
T: Clone,
§fn clone(&self) -> GetForwardedHeadersLayer<T>
fn clone(&self) -> GetForwardedHeadersLayer<T>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<T> Debug for GetForwardedHeadersLayer<T>where
T: Debug,
impl<T> Debug for GetForwardedHeadersLayer<T>where
T: Debug,
§impl Default for GetForwardedHeadersLayer
impl Default for GetForwardedHeadersLayer
§fn default() -> GetForwardedHeadersLayer
fn default() -> GetForwardedHeadersLayer
§impl<H, S> Layer<S> for GetForwardedHeadersLayer<H>
impl<H, S> Layer<S> for GetForwardedHeadersLayer<H>
§type Service = GetForwardedHeadersService<S, H>
type Service = GetForwardedHeadersService<S, H>
§fn layer(&self, inner: S) -> <GetForwardedHeadersLayer<H> as Layer<S>>::Service
fn layer(&self, inner: S) -> <GetForwardedHeadersLayer<H> as Layer<S>>::Service
Auto Trait Implementations§
impl<T> Freeze for GetForwardedHeadersLayer<T>
impl<T> RefUnwindSafe for GetForwardedHeadersLayer<T>
impl<T> Send for GetForwardedHeadersLayer<T>
impl<T> Sync for GetForwardedHeadersLayer<T>
impl<T> Unpin for GetForwardedHeadersLayer<T>
impl<T> UnwindSafe for GetForwardedHeadersLayer<T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<S, P, B, E>(self, other: P) -> And<T, P>
fn and<S, P, B, E>(self, other: P) -> And<T, P>
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.