Struct rama::http::layer::forwarded::SetForwardedHeadersLayer
pub struct SetForwardedHeadersLayer<T = Forwarded> { /* private fields */ }
Expand description
Layer to write Forwarded
information for this proxy,
added to the end of the chain of forwarded information already known.
This layer can set any header as long as you have a ForwardHeader
implementation
for the header you want to set. You can pass it as the type to the layer when creating
the layer using SetForwardedHeadersLayer::new
. Multiple headers (in order) can also be set
by specifying multiple types as a tuple.
The following headers are supported out of the box with each their own constructor:
SetForwardedHeadersLayer::forwarded
: the standardForwarded
headerRFC 7239
;SetForwardedHeadersLayer::via
: the canonicalVia
header (non-standard);SetForwardedHeadersLayer::x_forwarded_for
: the canonicalX-Forwarded-For
header (non-standard);SetForwardedHeadersLayer::x_forwarded_host
: the canonicalX-Forwarded-Host
header (non-standard);SetForwardedHeadersLayer::x_forwarded_proto
: the canonicalX-Forwarded-Proto
header (non-standard).
The “by” property is set to rama
by default. Use SetForwardedHeadersLayer::forward_by
to overwrite this,
typically with the actual IPv4
/IPv6
address of your proxy.
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 SetForwardedHeadersLayer
constructors for these headers,
but you can use the SetForwardedHeadersLayer::new
constructor and pass the header type as a type parameter,
alone or in a tuple with other headers.
§Example
This example shows how you could expose the real Client IP using the X-Real-IP
header.
use rama_net::stream::SocketInfo;
use rama_http::Request;
use rama_core::service::service_fn;
use rama_http::{headers::XRealIp, layer::forwarded::SetForwardedHeadersLayer};
use rama_core::{Context, Service, Layer};
use std::convert::Infallible;
async fn svc(_ctx: Context<State>, request: Request<Body>) -> Result<(), Infallible> {
// ...
}
let service = SetForwardedHeadersLayer::<XRealIp>::new()
.layer(service_fn(svc));
service.serve(ctx, req).await.unwrap();
Implementations§
§impl<T> SetForwardedHeadersLayer<T>
impl<T> SetForwardedHeadersLayer<T>
pub fn forward_by(
self,
node_id: impl Into<NodeId>,
) -> SetForwardedHeadersLayer<T>
pub fn forward_by( self, node_id: impl Into<NodeId>, ) -> SetForwardedHeadersLayer<T>
Set the given NodeId
as the “by” property, identifying this proxy.
Default of None
will be set to rama
otherwise.
pub fn set_forward_by(
&mut self,
node_id: impl Into<NodeId>,
) -> &mut SetForwardedHeadersLayer<T>
pub fn set_forward_by( &mut self, node_id: impl Into<NodeId>, ) -> &mut SetForwardedHeadersLayer<T>
Set the given NodeId
as the “by” property, identifying this proxy.
Default of None
will be set to rama
otherwise.
§impl<T> SetForwardedHeadersLayer<T>
impl<T> SetForwardedHeadersLayer<T>
pub fn new() -> SetForwardedHeadersLayer<T>
pub fn new() -> SetForwardedHeadersLayer<T>
Create a new SetForwardedHeadersLayer
for the specified headers T
.
§impl SetForwardedHeadersLayer
impl SetForwardedHeadersLayer
pub fn forwarded() -> SetForwardedHeadersLayer
pub fn forwarded() -> SetForwardedHeadersLayer
Create a new SetForwardedHeadersLayer
for the standard Forwarded
header.
§impl SetForwardedHeadersLayer<Via>
impl SetForwardedHeadersLayer<Via>
pub fn via() -> SetForwardedHeadersLayer<Via>
pub fn via() -> SetForwardedHeadersLayer<Via>
Create a new SetForwardedHeadersLayer
for the canonical Via
header.
§impl SetForwardedHeadersLayer<XForwardedFor>
impl SetForwardedHeadersLayer<XForwardedFor>
pub fn x_forwarded_for() -> SetForwardedHeadersLayer<XForwardedFor>
pub fn x_forwarded_for() -> SetForwardedHeadersLayer<XForwardedFor>
Create a new SetForwardedHeadersLayer
for the canonical [X-Forwarded-For
] header.
§impl SetForwardedHeadersLayer<XForwardedHost>
impl SetForwardedHeadersLayer<XForwardedHost>
pub fn x_forwarded_host() -> SetForwardedHeadersLayer<XForwardedHost>
pub fn x_forwarded_host() -> SetForwardedHeadersLayer<XForwardedHost>
Create a new SetForwardedHeadersLayer
for the canonical [X-Forwarded-Host
] header.
§impl SetForwardedHeadersLayer<XForwardedProto>
impl SetForwardedHeadersLayer<XForwardedProto>
pub fn x_forwarded_proto() -> SetForwardedHeadersLayer<XForwardedProto>
pub fn x_forwarded_proto() -> SetForwardedHeadersLayer<XForwardedProto>
Create a new SetForwardedHeadersLayer
for the canonical [X-Forwarded-Proto
] header.
Trait Implementations§
§impl<T> Clone for SetForwardedHeadersLayer<T>where
T: Clone,
impl<T> Clone for SetForwardedHeadersLayer<T>where
T: Clone,
§fn clone(&self) -> SetForwardedHeadersLayer<T>
fn clone(&self) -> SetForwardedHeadersLayer<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 SetForwardedHeadersLayer<T>where
T: Debug,
impl<T> Debug for SetForwardedHeadersLayer<T>where
T: Debug,
§impl Default for SetForwardedHeadersLayer
impl Default for SetForwardedHeadersLayer
§fn default() -> SetForwardedHeadersLayer
fn default() -> SetForwardedHeadersLayer
§impl<H, S> Layer<S> for SetForwardedHeadersLayer<H>
impl<H, S> Layer<S> for SetForwardedHeadersLayer<H>
§type Service = SetForwardedHeadersService<S, H>
type Service = SetForwardedHeadersService<S, H>
§fn layer(&self, inner: S) -> <SetForwardedHeadersLayer<H> as Layer<S>>::Service
fn layer(&self, inner: S) -> <SetForwardedHeadersLayer<H> as Layer<S>>::Service
Auto Trait Implementations§
impl<T> Freeze for SetForwardedHeadersLayer<T>
impl<T> RefUnwindSafe for SetForwardedHeadersLayer<T>
impl<T> Send for SetForwardedHeadersLayer<T>
impl<T> Sync for SetForwardedHeadersLayer<T>
impl<T> Unpin for SetForwardedHeadersLayer<T>
impl<T> UnwindSafe for SetForwardedHeadersLayer<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.