Struct ProblemDetails 

pub struct ProblemDetails {
    pub type_: String,
    pub title: Option<String>,
    pub status: u16,
    pub detail: Option<String>,
    pub instance: Option<String>,
    pub code: Option<String>,
}

RFC 7807 problem details body.

Retained for projects that prefer the standard RFC 7807 envelope. #[derive(ApiError)] no longer emits this by default — see ApiErrorBody for the new default. Both types coexist; choose whichever fits your client conventions.

Fields

type_: String

A URI reference identifying the problem type. Defaults to "about:blank" per the RFC.

title: Option<String>

Short human-readable summary of the problem type.

status: u16

HTTP status code generated for this occurrence.

detail: Option<String>

Human-readable explanation specific to this occurrence.

instance: Option<String>

URI reference identifying the specific occurrence.

code: Option<String>

Application-level error code suitable for client discrimination.

Implementations

impl ProblemDetails

pub fn new(status: u16) -> Self

Construct with the required status field.

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title.

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

Set the detail message.

pub fn with_code(self, code: impl Into<String>) -> Self

Set the application-level error code.

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

Set the instance URI.

pub fn with_type(self, type_: impl Into<String>) -> Self

Set the problem type URI.

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 ComposeSchema for ProblemDetails

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

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 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.

impl ToSchema for ProblemDetails

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.