Struct ProblemDetail 

pub struct ProblemDetail {
    pub type_uri: String,
    pub title: String,
    pub status: u16,
    pub detail: Option<String>,
    pub instance: Option<String>,
    pub error_code: Option<&'static str>,
}

RFC 7807 Problem Details JSON body.

Fields

type_uri: String

URI reference identifying the problem type.

title: String

Short human-readable summary.

status: u16

HTTP status code.

detail: Option<String>

Human-readable explanation specific to this occurrence.

instance: Option<String>

URI reference identifying the specific occurrence.

error_code: Option<&'static str>

Stable machine-readable error code (e.g. "invalid_threshold") for clients that need to branch on the specific failure without parsing the human-readable detail. Omitted from the wire when unset so existing endpoints stay byte-identical.

Codes are static identifiers — &'static str keeps the struct small enough that handlers returning Result<_, ProblemDetail> stay under clippy’s result_large_err threshold.

Implementations

impl ProblemDetail

pub fn from_status(status: StatusCode) -> Self

Create a ProblemDetail from an HTTP status code.

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

Attach a human-readable detail message.

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

Attach the request URI as the instance identifier.

pub fn with_error_code(self, code: &'static str) -> Self

Attach a stable machine-readable error code.

Trait Implementations

impl Clone for ProblemDetail

fn clone(&self) -> ProblemDetail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ProblemDetail

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for ProblemDetail

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

Formats the value using the given formatter.

impl IntoResponse for ProblemDetail

fn into_response(self) -> Response

Create a response.

impl Serialize for ProblemDetail

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for ProblemDetail

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.