Struct RequestIDMiddleware

pub struct RequestIDMiddleware { /* private fields */ }

Middleware for generating and managing request IDs

This middleware generates a unique ID for each request and adds it to the response headers. ID generation methods and header names can be customized.

Implementations

impl RequestIDMiddleware

pub fn new() -> Self

Create middleware with default ID length (36 characters)

pub fn with_id_length(self, length: usize) -> Self

Set custom ID length

Arguments

• length - The desired length of the request ID

Panics

Panics if length is 0.

pub fn generator<F>(self, f: F) -> Self

where F: Fn() -> String + Send + Sync + 'static,

Set a custom ID generation function

Arguments

• f - Function to generate request IDs

pub fn header_name<T: Into<String>>(self, header_name: T) -> Self

Set a custom header name

Arguments

• header_name - Header name to use

pub fn with_full_uuid(self) -> Self

Configure to use full UUID v4 format (36 characters with hyphens)

pub fn with_simple_uuid(self) -> Self

Configure to use simple UUID format (32 characters without hyphens)

pub fn with_custom_uuid_format<F>(self, formatter: F) -> Self

where F: Fn(Uuid) -> String + Send + Sync + 'static,

Configure to use custom UUID format

Arguments

• formatter - Function to format UUID

pub fn get_id_length(&self) -> usize

Get the currently configured ID length

Trait Implementations

impl Default for RequestIDMiddleware

fn default() -> Self

Returns the “default value” for a type.

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

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

type Response = ServiceResponse<B>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = RequestIDService<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<RequestIDMiddleware as Transform<S, ServiceRequest>>::Transform, <RequestIDMiddleware 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