Struct RequestContext

Source

pub struct RequestContext { /* private fields */ }

Expand description

Request/correlation context attached to request extensions.

RequestContext is available to handlers when the router uses crate::middleware::validated_request_id_layer plus crate::middleware::request_context_layer, or when it is wrapped by crate::middleware::ApiDefaults::production. Extracting it without those extensions rejects the request with 500 Internal Server Error.

Fields are inferred from request headers and Axum extensions:

request_id: the final validated/generated x-request-id
correlation_id: x-correlation-id, falling back to the request ID
trace_id: the trace-id segment from traceparent
client_kind: x-api-key means API key, otherwise Authorization means authenticated, otherwise anonymous
route: Axum’s axum::extract::MatchedPath when it is available at the point the context layer runs

use nidus_http::{Json, context::RequestContext};

async fn handler(context: RequestContext) -> Json<serde_json::Value> {
    Json(serde_json::json!({
        "requestId": context.request_id(),
        "correlationId": context.correlation_id(),
    }))
}

Implementations§

Source §

impl RequestContext

Source

pub fn new( request_id: impl Into<String>, method: Method, path: impl Into<String>, ) -> Self

Creates a context for the current request boundary.

This constructor is useful in tests or custom middleware. It does not inspect headers, so optional correlation, trace, route, and client fields remain empty/default until set explicitly or built via Self::from_parts.

Source

pub fn from_parts(parts: &Parts, request_id: impl Into<String>) -> Self

Creates a context from request parts.

This reads x-correlation-id, traceparent, x-api-key, Authorization, and axum::extract::MatchedPath from the request boundary. The supplied request_id is expected to be the final ID chosen by request ID middleware.

Source

pub fn request_id(&self) -> &str

Returns the final request id.

With crate::middleware::validated_request_id_layer, this is either a valid inbound UUID v4 or a generated ID.

Source

pub fn correlation_id(&self) -> Option<&str>

Returns the correlation id when available.

Self::from_parts prefers x-correlation-id and falls back to the request ID when no correlation header is present.

Source

pub const fn method(&self) -> &Method

Returns the request method.

Source

pub fn route(&self) -> Option<&str>

Returns the stable matched route pattern when available.

This depends on Axum’s axum::extract::MatchedPath extension being present before the context is built. Layer placement can affect whether this is available for a given router shape.

Source

pub fn path(&self) -> &str

Returns the raw request path.

Source

pub fn trace_id(&self) -> Option<&str>

Returns the trace id when available.

The value is extracted from the second segment of the W3C traceparent header. Use [crate::otel::extract_trace_context] when the otel feature is enabled and you need full trace/span validation.

Source