Struct CorrelationContext 

pub struct CorrelationContext { /* private fields */ }

Per-request correlation context. Cheaply clonable via Arc. Shares the underlying request state; mutating one clone is visible to the others.

Implementations

impl CorrelationContext

pub fn new() -> Self

Creates a context with fresh random correlation and request IDs, Once flow, no user, and a default pagination limit of 15.

pub fn with_ids(correlation_id: &str, request_id: &str) -> Self

Creates a context with the given correlation and request IDs. Other state matches CorrelationContext::new.

pub fn is_multipart(&self) -> bool

Whether the request arrived as multipart/form-data.

pub fn multipart(&self) -> Option<MultipartBody>

Decoded multipart payload, if the request was multipart.

pub fn form_field(&self, name: &str) -> Option<String>

First value of a multipart text field, if the request was multipart.

pub fn form_field_all(&self, name: &str) -> Vec<String>

All values of a repeated multipart text field.

pub fn files(&self) -> Vec<UploadedFile>

Uploaded files in part order. Returns an empty vector when not multipart.

pub fn files_for(&self, field: &str) -> Vec<UploadedFile>

Uploaded files for one form field.

pub fn body_bytes(&self) -> Option<Vec<u8>>

Raw request body bytes, if any.

pub fn body_string(&self) -> Result<String, ErrorResult>

Raw request body as a string. For multipart requests the body form field wins when present; otherwise the raw payload is decoded as UTF-8. Returns a 400 error when there is no request body, or it is not valid UTF-8. No validation is applied to unstructured payloads.

pub fn body<T>(&self) -> Result<T, ErrorResult>

where T: DocumentableDTO + Validate,

Deserializes and validates the request body as T.

Multipart requests decode the DTO from the body form field when present, otherwise from the merged text fields. Non-multipart bodies accept JSON with a form-urlencoded fallback. Returns a 400 error when the body is missing, cannot be deserialized, or fails Validate.

let dto: MyDto = ctx.body::<MyDto>()?;

pub fn headers(&self) -> HeaderMap

All request headers attached at dispatch.

pub fn header(&self, name: &str) -> Option<String>

A single request header value, if present.

pub fn query_params(&self) -> HashMap<String, String>

All query parameters attached at dispatch.

pub fn query_param(&self, name: &str) -> Option<String>

A single query parameter value, if present.

pub fn query_param_or(&self, name: &str, default: &str) -> String

A query parameter value, or default when absent.

pub fn correlation_id(&self) -> String

Returns the correlation ID shared across related requests.

pub fn request_id(&self) -> String

Returns the ID unique to this request.

pub fn set_request_id(&self, id: &str)

Replaces the request ID.

pub fn set_correlation_id(&self, id: &str)

Replaces the correlation ID.

pub fn flow(&self) -> CorrelationFlow

Returns the current lifecycle flow marker.

pub fn set_flow(&self, flow: CorrelationFlow)

Replaces the lifecycle flow marker.

pub fn with_flow(self, flow: CorrelationFlow) -> Self

Sets the lifecycle flow marker and returns the context for chaining.

pub fn with_correlation_id(self, id: &str) -> Self

Sets the correlation ID and returns the context for chaining.

pub fn user_id(&self) -> Option<String>

Returns the authenticated user ID, if one was attached.

pub fn set_user_id(&self, id: Option<String>)

Sets or clears the authenticated user ID.

pub fn set(&self, key: &str, value: String)

Stores an arbitrary string value under key.

pub fn get(&self, key: &str) -> Option<String>

Returns the arbitrary string value stored under key, if any.

pub fn pagination_cursor(&self) -> Option<String>

Returns the pagination cursor, if one was attached.

pub fn pagination_limit(&self) -> usize

Returns the pagination limit (defaults to 15).

pub fn set_pagination(&self, cursor: Option<String>, limit: usize)

Sets the pagination cursor and limit.

pub fn client_ip(headers: &HeaderMap, remote_addr: Option<SocketAddr>) -> String

Extracts the client IP, preferring x-forwarded-for (first entry), then x-real-ip, then the socket address, else "unknown".

Trait Implementations

impl Clone for CorrelationContext

fn clone(&self) -> CorrelationContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationContext

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

Formats the value using the given formatter.

impl Default for CorrelationContext

fn default() -> Self

Returns the “default value” for a type.