Struct SetRequestId

pub struct SetRequestId<S, M> { /* private fields */ }

Available on crate feature request-id only.

Set request id headers and extensions on requests.

See the module docs for an example.

If MakeRequestId::make_request_id returns Some(_) and the request doesn’t already have a header with the same name, then the header will be inserted.

Additionally RequestId will be inserted into Request::extensions so other services can access it.

Implementations

impl<S, M> SetRequestId<S, M>

pub fn new(inner: S, header_name: HeaderName, make_request_id: M) -> Self

where M: MakeRequestId,

Create a new SetRequestId.

pub fn x_request_id(inner: S, make_request_id: M) -> Self

where M: MakeRequestId,

Create a new SetRequestId that uses x-request-id as the header name.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn layer( header_name: HeaderName, make_request_id: M, ) -> SetRequestIdLayer<M>

where M: MakeRequestId,

Returns a new Layer that wraps services with a SetRequestId middleware.

Trait Implementations

impl<S: Clone, M: Clone> Clone for SetRequestId<S, M>

fn clone(&self) -> SetRequestId<S, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug, M: Debug> Debug for SetRequestId<S, M>

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

Formats the value using the given formatter.

impl<S, M, ReqBody, ResBody> Service<Request<ReqBody>> for SetRequestId<S, M>

where S: Service<Request<ReqBody>, Response = Response<ResBody>>, M: MakeRequestId,

type Response = <S as Service<Request<ReqBody>>>::Response

Responses given by the service.

type Error = <S as Service<Request<ReqBody>>>::Error

Errors produced by the service.

type Future = <S as Service<Request<ReqBody>>>::Future

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<ReqBody>) -> Self::Future

Process the request and return the response asynchronously.