Struct ProblemDetails 

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

RFC 7807 Problem Details for HTTP APIs

This struct represents a standardized error response format as defined in RFC 7807. It provides a consistent way to communicate error information in HTTP APIs.

Fields

problem_type: String

A URI reference that identifies the problem type

title: String

A short, human-readable summary of the problem type

status: u16

The HTTP status code generated by the origin server

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

extensions: HashMap<String, Value>

Additional problem-specific extension fields

Implementations

impl ProblemDetails

pub fn new( problem_type: impl Into<String>, title: impl Into<String>, status: u16, ) -> Self

Create a new ProblemDetails with required fields

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

Set the detail field

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

Set the instance field

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

Add an extension field

pub fn validation_error(detail: impl Into<String>) -> Self

Create a validation error problem

pub fn authentication_error() -> Self

Create an authentication error problem

pub fn authorization_error() -> Self

Create an authorization error problem

pub fn not_found(resource: impl Into<String>) -> Self

Create a not found error problem

pub fn internal_server_error() -> Self

Create an internal server error problem

pub fn service_unavailable() -> Self

Create a service unavailable error problem

pub fn custom_problem( problem_type: impl Into<String>, title: impl Into<String>, status: u16, ) -> Self

Create a custom problem with explicit URI

impl ProblemDetails

Get the HTTP status code from ProblemDetails

pub fn status_code(&self) -> StatusCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProblemDetails

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoResponse for ProblemDetails

fn into_response(self) -> Response

Create a response.

impl JsonSchema for ProblemDetails

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ProblemDetails

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

where __S: Serializer,

Serialize this value into the given Serde serializer.