Skip to main content

RequestIdLayer

Struct RequestIdLayer 

Source
pub struct RequestIdLayer { /* private fields */ }
Expand description

Middleware that ensures every request/response pair carries a stable correlation ID.

  • If the incoming request already has the header (e.g. set by an upstream gateway, load balancer, or calling service), that exact value is kept and echoed back unchanged — this lets one ID follow a request across multiple services instead of getting a new one at each hop.
  • Otherwise, a fresh ID is generated with generate_request_id and injected into the request before it reaches your handler, so handlers can read it like any other header.
  • The same value is always set on the response, so the caller can log it too — even if it arrived with no ID and this middleware generated one.

Implementations§

Source§

impl RequestIdLayer

Source

pub fn new() -> Self

Uses the default header name, DEFAULT_HEADER (X-Request-Id).

Source

pub fn header(self, name: impl Into<String>) -> Self

Use a different header name, e.g. "X-Correlation-Id".

Trait Implementations§

Source§

impl Default for RequestIdLayer

Source§

fn default() -> Self

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

impl Middleware for RequestIdLayer

Source§

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

Headers only: a streamed body passes through untouched.

Source§

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

In-memory only: safe on the event loop.

Source§

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

Source§

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.
Source§

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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