rama_http::layer::forwarded

Struct SetForwardedHeadersLayer

Source 
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:

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 and True-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§

Source§

impl<T> SetForwardedHeadersLayer<T>

Source

pub fn forward_by(self, node_id: impl Into<NodeId>) -> Self

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

Default of None will be set to rama otherwise.

Source

pub fn set_forward_by(&mut self, node_id: impl Into<NodeId>) -> &mut Self

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

Default of None will be set to rama otherwise.

Source§

impl<T> SetForwardedHeadersLayer<T>

Source

pub fn new() -> Self

Create a new SetForwardedHeadersLayer for the specified headers T.

Source§

impl SetForwardedHeadersLayer

Source

pub fn forwarded() -> Self

Create a new SetForwardedHeadersLayer for the standard Forwarded header.

Source§

impl SetForwardedHeadersLayer<Via>

Source

pub fn via() -> Self

Create a new SetForwardedHeadersLayer for the canonical Via header.

Source§

impl SetForwardedHeadersLayer<XForwardedFor>

Source

pub fn x_forwarded_for() -> Self

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

Source§

impl SetForwardedHeadersLayer<XForwardedHost>

Source

pub fn x_forwarded_host() -> Self

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

Source§

impl SetForwardedHeadersLayer<XForwardedProto>

Source

pub fn x_forwarded_proto() -> Self

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

Trait Implementations§

Source§

impl<T: Clone> Clone for SetForwardedHeadersLayer<T>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for SetForwardedHeadersLayer<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SetForwardedHeadersLayer

Source§

fn default() -> Self

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

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

Source§

type Service = SetForwardedHeadersService<S, H>

The service produced by the layer.
Source§

fn layer(&self, inner: S) -> Self::Service

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

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

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

fn with_current_context(self) -> WithContext<Self>

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

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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
Source§

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

Source§

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

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

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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