rama::http::layer::forwarded

Struct SetForwardedHeaderLayer

pub struct SetForwardedHeaderLayer<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 SetForwardedHeaderLayer::new.

The following headers are supported out of the box with each their own constructor:

SetForwardedHeaderLayer::forwarded: the standard Forwarded header RFC 7239;
SetForwardedHeaderLayer::via: the canonical Via header (non-standard);
SetForwardedHeaderLayer::x_forwarded_for: the canonical X-Forwarded-For header (non-standard);
SetForwardedHeaderLayer::x_forwarded_host: the canonical X-Forwarded-Host header (non-standard);
SetForwardedHeaderLayer::x_forwarded_proto: the canonical X-Forwarded-Proto header (non-standard).

The “by” property is set to rama by default. Use SetForwardedHeaderLayer::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 and True-Client-Ip.

There are no SetForwardedHeaderLayer constructors for these headers, but you can use the SetForwardedHeaderLayer::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][crate::headers::XRealIp] header.

use rama_net::stream::SocketInfo;
use rama_http::Request;
use rama_core::service::service_fn;
use rama_http::{headers::forwarded::XRealIp, layer::forwarded::SetForwardedHeaderLayer};
use rama_core::{Context, Service, Layer};
use std::convert::Infallible;


async fn svc(_ctx: Context, request: Request<Body>) -> Result<(), Infallible> {
    // ...
}

let service = SetForwardedHeaderLayer::<XRealIp>::new()
    .into_layer(service_fn(svc));

service.serve(ctx, req).await.unwrap();

Implementations§

impl<T> SetForwardedHeaderLayer<T>

pub fn forward_by( self, node_id: impl Into<NodeId>, ) -> SetForwardedHeaderLayer<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 SetForwardedHeaderLayer<T>

Set the given NodeId as the “by” property, identifying this proxy.

Default of None will be set to rama otherwise.

impl<T> SetForwardedHeaderLayer<T>

pub fn new() -> SetForwardedHeaderLayer<T>

Create a new SetForwardedHeaderLayer for the specified headers T.

impl SetForwardedHeaderLayer

pub fn forwarded() -> SetForwardedHeaderLayer

Create a new SetForwardedHeaderLayer for the standard Forwarded header.

impl SetForwardedHeaderLayer<Via>

pub fn via() -> SetForwardedHeaderLayer<Via>

Create a new SetForwardedHeaderLayer for the canonical Via header.

impl SetForwardedHeaderLayer<XForwardedFor>

pub fn x_forwarded_for() -> SetForwardedHeaderLayer<XForwardedFor>

Create a new SetForwardedHeaderLayer for the canonical [X-Forwarded-For] header.

impl SetForwardedHeaderLayer<XForwardedHost>

pub fn x_forwarded_host() -> SetForwardedHeaderLayer<XForwardedHost>

Create a new SetForwardedHeaderLayer for the canonical [X-Forwarded-Host] header.

impl SetForwardedHeaderLayer<XForwardedProto>

pub fn x_forwarded_proto() -> SetForwardedHeaderLayer<XForwardedProto>

Create a new SetForwardedHeaderLayer for the canonical [X-Forwarded-Proto] header.

Trait Implementations§

impl<T> Clone for SetForwardedHeaderLayer<T>
where T: Clone,

fn clone(&self) -> SetForwardedHeaderLayer<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for SetForwardedHeaderLayer<T>
where T: Debug,

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

Formats the value using the given formatter. Read more

impl Default for SetForwardedHeaderLayer

fn default() -> SetForwardedHeaderLayer

Returns the “default value” for a type. Read more

impl<H, S> Layer<S> for SetForwardedHeaderLayer<H>

type Service = SetForwardedHeaderService<S, H>

The service produced by the layer.

fn layer(&self, inner: S) -> <SetForwardedHeaderLayer<H> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer( self, inner: S, ) -> <SetForwardedHeaderLayer<H> as Layer<S>>::Service

Same as layer but consuming self after the service was created. Read more

Auto Trait Implementations§

impl<T> Freeze for SetForwardedHeaderLayer<T>

impl<T> RefUnwindSafe for SetForwardedHeaderLayer<T>

impl<T> Send for SetForwardedHeaderLayer<T>

impl<T> Sync for SetForwardedHeaderLayer<T>

impl<T> Unpin for SetForwardedHeaderLayer<T>

impl<T> UnwindSafe for SetForwardedHeaderLayer<T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T, U> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,