Struct ProblemDetails 

pub struct ProblemDetails {
    pub type_uri: String,
    pub title: String,
    pub status: u16,
    pub detail: Option<String>,
    pub instance: Option<String>,
    pub extensions: HashMap<String, Value>,
}

RFC 9457 Problem Details for HTTP APIs

A machine-readable format for specifying errors in HTTP API responses. Per RFC 9457, all fields are optional. The type field defaults to “about:blank” if not specified.

Content-Type

Responses using this struct should set:

Content-Type: application/problem+json

Example

{
  "type": "https://spikard.dev/errors/validation-error",
  "title": "Request Validation Failed",
  "status": 422,
  "detail": "2 validation errors in request body",
  "errors": [...]
}

Fields

type_uri: String

A URI reference that identifies the problem type. Defaults to “about:blank” when absent. Should be a stable, human-readable identifier for the problem type.

title: String

A short, human-readable summary of the problem type. Should not change from occurrence to occurrence of the problem.

status: u16

The HTTP status code generated by the origin server. This is advisory; the actual HTTP status code takes precedence.

detail: Option<String>

A human-readable explanation specific to this occurrence of the problem.

instance: Option<String>

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

extensions: HashMap<String, Value>

Extension members - problem-type-specific data. For validation errors, this typically contains an “errors” array.

Implementations

impl ProblemDetails

pub const TYPE_VALIDATION_ERROR: &'static str = "https://spikard.dev/errors/validation-error"

Standard type URI for validation errors (422)

pub const TYPE_NOT_FOUND: &'static str = "https://spikard.dev/errors/not-found"

Standard type URI for not found errors (404)

pub const TYPE_METHOD_NOT_ALLOWED: &'static str = "https://spikard.dev/errors/method-not-allowed"

Standard type URI for method not allowed (405)

pub const TYPE_INTERNAL_SERVER_ERROR: &'static str = "https://spikard.dev/errors/internal-server-error"

Standard type URI for internal server error (500)

pub const TYPE_BAD_REQUEST: &'static str = "https://spikard.dev/errors/bad-request"

Standard type URI for bad request (400)

pub fn new( type_uri: impl Into<String>, title: impl Into<String>, status: StatusCode, ) -> ProblemDetails

Create a new ProblemDetails with required fields

pub fn with_detail(self, detail: impl Into<String>) -> ProblemDetails

Set the detail field

pub fn with_instance(self, instance: impl Into<String>) -> ProblemDetails

Set the instance field

pub fn with_extension( self, key: impl Into<String>, value: Value, ) -> ProblemDetails

Add an extension field

pub fn with_extensions(self, extensions: Value) -> ProblemDetails

Add all extensions from a JSON object

pub fn from_validation_error(error: &ValidationError) -> ProblemDetails

Create a validation error Problem Details from ValidationError

This converts the FastAPI-style validation errors to RFC 9457 format:

• type: “https://spikard.dev/errors/validation-error”
• title: “Request Validation Failed”
• status: 422
• detail: Summary of error count
• errors: Array of validation error details (as extension field)

pub fn not_found(detail: impl Into<String>) -> ProblemDetails

Create a not found error

pub fn method_not_allowed(detail: impl Into<String>) -> ProblemDetails

Create a method not allowed error

pub fn internal_server_error(detail: impl Into<String>) -> ProblemDetails

Create an internal server error

pub fn internal_server_error_debug( detail: impl Into<String>, exception: impl Into<String>, traceback: impl Into<String>, request_data: Value, ) -> ProblemDetails

Create an internal server error with debug information

Includes exception details, traceback, and request data for debugging. Only use in development/debug mode.

pub fn bad_request(detail: impl Into<String>) -> ProblemDetails

Create a bad request error

pub fn status_code(&self) -> StatusCode

Get the HTTP status code

pub fn to_json(&self) -> Result<String, Error>

Serialize to JSON string

pub fn to_json_pretty(&self) -> Result<String, Error>

Serialize to pretty JSON string

Trait Implementations

impl Clone for ProblemDetails

fn clone(&self) -> ProblemDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProblemDetails

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

Formats the value using the given formatter.

impl Serialize for ProblemDetails

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.