rama_http::layer::forwarded

Struct SetForwardedHeadersService

pub struct SetForwardedHeadersService<S, T = Forwarded> { /* private fields */ }

Expand description

Middleware Service to write Forwarded information for this proxy, added to the end of the chain of forwarded information already known.

See SetForwardedHeadersLayer for more information.

Implementations§

impl<S, T> SetForwardedHeadersService<S, T>

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.

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.

impl<S, T> SetForwardedHeadersService<S, T>

pub fn new(inner: S) -> Self

Create a new SetForwardedHeadersService for the specified headers T.

impl<S> SetForwardedHeadersService<S>

pub fn forwarded(inner: S) -> Self

Create a new SetForwardedHeadersService for the standard Forwarded header.

impl<S> SetForwardedHeadersService<S, Via>

pub fn via(inner: S) -> Self

Create a new SetForwardedHeadersService for the canonical Via header.

impl<S> SetForwardedHeadersService<S, XForwardedFor>

pub fn x_forwarded_for(inner: S) -> Self

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

impl<S> SetForwardedHeadersService<S, XForwardedHost>

pub fn x_forwarded_host(inner: S) -> Self

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

impl<S> SetForwardedHeadersService<S, XForwardedProto>

pub fn x_forwarded_proto(inner: S) -> Self

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

Trait Implementations§

impl<S: Clone, T> Clone for SetForwardedHeadersService<S, T>

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

impl<S: Debug, T> Debug for SetForwardedHeadersService<S, T>

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

Formats the value using the given formatter. Read more

impl<S, T1, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1,)>
where T1: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, T7, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6, T7)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, T7: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6, T7, T8)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, T7: ForwardHeader + Send + Sync + 'static, T8: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6, T7, T8, T9)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, T7: ForwardHeader + Send + Sync + 'static, T8: ForwardHeader + Send + Sync + 'static, T9: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, T7: ForwardHeader + Send + Sync + 'static, T8: ForwardHeader + Send + Sync + 'static, T9: ForwardHeader + Send + Sync + 'static, T10: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, T7: ForwardHeader + Send + Sync + 'static, T8: ForwardHeader + Send + Sync + 'static, T9: ForwardHeader + Send + Sync + 'static, T10: ForwardHeader + Send + Sync + 'static, T11: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)>
where T1: ForwardHeader + Send + Sync + 'static, T2: ForwardHeader + Send + Sync + 'static, T3: ForwardHeader + Send + Sync + 'static, T4: ForwardHeader + Send + Sync + 'static, T5: ForwardHeader + Send + Sync + 'static, T6: ForwardHeader + Send + Sync + 'static, T7: ForwardHeader + Send + Sync + 'static, T8: ForwardHeader + Send + Sync + 'static, T9: ForwardHeader + Send + Sync + 'static, T10: ForwardHeader + Send + Sync + 'static, T11: ForwardHeader + Send + Sync + 'static, T12: ForwardHeader + Send + Sync + 'static, S: Service<State, Request<Body>, Error: Into<BoxError>>, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, H, State, Body> Service<State, Request<Body>> for SetForwardedHeadersService<S, H>
where S: Service<State, Request<Body>, Error: Into<BoxError>>, H: ForwardHeader + Send + Sync + 'static, Body: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<Body>>>::Response

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<Body>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

impl<S, T> Freeze for SetForwardedHeadersService<S, T>
where S: Freeze,

impl<S, T> RefUnwindSafe for SetForwardedHeadersService<S, T>
where S: RefUnwindSafe,

impl<S, T> Send for SetForwardedHeadersService<S, T>
where S: Send,

impl<S, T> Sync for SetForwardedHeadersService<S, T>
where S: Sync,

impl<S, T> Unpin for SetForwardedHeadersService<S, T>
where S: Unpin,

impl<S, T> UnwindSafe for SetForwardedHeadersService<S, T>
where S: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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, dst: *mut u8)

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

Performs copy-assignment from self to dst. Read more

impl<S, State, Request, Connection> ConnectorService<State, Request> for S
where S: Service<State, Request, Response = EstablishedClientConnection<Connection, State, Request>>, <S as Service<State, Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

type Connection = Connection

Connection returned by the ConnectorService

type Error = <S as Service<State, Request>>::Error

Error returned in case of connection / setup failure

fn connect( &self, ctx: Context<State>, req: Request, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<State, Request>>::Connection, State, Request>, <S as ConnectorService<State, Request>>::Error>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival.

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<State, S, Body> HttpClientExt<State> for S
where S: Service<State, Request<Body>, Response = Response<Body>>, <S as Service<State, Request<Body>>>::Error: Into<Box<dyn Error + Sync + Send>>,

type ExecuteResponse = Response<Body>

The response type returned by the execute method.

type ExecuteError = <S as Service<State, Request<Body>>>::Error

The error type returned by the execute method.

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Start building a Request with the Method and Url. Read more

fn execute( &self, ctx: Context<State>, request: Request<Body>, ) -> impl Future<Output = Result<<S as HttpClientExt<State>>::ExecuteResponse, <S as HttpClientExt<State>>::ExecuteError>>

Executes a Request. 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<State, S, R> IntoEndpointService<State, (State, R)> for S
where State: Clone + Send + Sync + 'static, S: Service<State, Request<Body>, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

fn into_endpoint_service( self, ) -> impl Service<State, Request<Body>, Response = Response<Body>, Error = Infallible>

convert the type into a rama_core::Service.

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

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

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

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