Struct Correlation

pub struct Correlation { /* private fields */ }

Implementations

impl Correlation

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

where T: Into<HeaderName>,

Sets the name of the header from which the Correlation ID is read from the request.

pub fn enforce_request_header(self, enforce: bool) -> Self

Enforce the inclusion of the correlation ID request header.

If true and the supposed correlation ID header is not included, the request will fail with a 400 Bad Request response.

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

where T: Into<HeaderName>,

The name of the header to which the correlation ID is written for the response.

pub fn include_in_response(self, include_in_response: bool) -> Self

Controls whether the correlation ID is returned in the response headers.

pub fn with_id_generator( self, id_generator: Box<dyn CorrelationIdGenerator>, ) -> Self

Use the provided generator for creating a CorrelationId instead of the default one.

Trait Implementations

impl Default for Correlation

fn default() -> Self

Creates the default instance of Correlation with the following configuration:

• request header name: "x-correlation-id",
• enforce request header: false,
• response header name: "x-correlation-id",
• include in response: true,
• ID generator: simple UUID (v4).

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

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

type Response = ServiceResponse<B>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type InitError = ()

Errors produced while building a transform service.

type Transform = CorrelationMiddleware<S>

The TransformService value created by this factory

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