Struct RequestIdentifier

pub struct RequestIdentifier { /* private fields */ }

A middleware for generating per-request unique IDs

Implementations

impl RequestIdentifier

pub fn with_uuid() -> Self

Create a default middleware using DEFAULT_HEADER as the header name and UUID v4 for ID generation.

pub fn with_header(header_name: &'static str) -> Self

Create a middleware using a custom header name and UUID v4 for ID generation.

pub const fn header(self, header_name: &'static str) -> Self

Change the header name for this middleware.

pub fn with_generator(id_generator: fn() -> HeaderValue) -> Self

Create a middleware using DEFAULT_HEADER as the header name and IDs as generated by id_generator. id_generator should return a unique ID (ASCII only), each time it is invoked.

pub fn generator(self, id_generator: fn() -> HeaderValue) -> Self

Change the ID generator for this middleware.

pub fn use_incoming_id(self, use_incoming_id: IdReuse) -> Self

Change the behavior for incoming request id headers. When this is set to IdReuse::UseIncoming (the default), each request is checked if it contains a header by the specified name and if it exists, the id from that header is used, otherwise a random id is generated. When this is set to IdReuse::IgnoreIncoming, the id from the request header is ignored.

Trait Implementations

impl Default for RequestIdentifier

fn default() -> Self

Returns the “default value” for a type.

impl<S, B> Transform<S, ServiceRequest> for RequestIdentifier

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, S::Future: 'static, B: 'static,

type Response = <S as Service<ServiceRequest>>::Response

Responses produced by the service.

type Error = <S as Service<ServiceRequest>>::Error

Errors produced by the service.

type Transform = RequestIdMiddleware<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<RequestIdentifier as Transform<S, ServiceRequest>>::Transform, <RequestIdentifier as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously