Skip to main content

ProblemDetailsSchema

Struct ProblemDetailsSchema 

Source
#[non_exhaustive]
pub struct ProblemDetailsSchema { pub detail: Option<String>, pub status: i32, pub title: String, pub type_: String, }
Expand description

Standard error response body, returned for every non-2xx response.

This follows the RFC 7807 “Problem Details” shape: a stable machine-readable type, a short title, the repeated HTTP status code, and an optional detail string with specifics of this particular occurrence.

JSON schema
{
 "description": "Standard error response body, returned for every non-2xx response.\n\nThis follows the RFC 7807 \"Problem Details\" shape: a stable machine-readable\n`type`, a short `title`, the repeated HTTP `status` code, and an optional\n`detail` string with specifics of this particular occurrence.",
 "type": "object",
 "required": [
   "status",
   "title",
   "type"
 ],
 "properties": {
   "detail": {
     "description": "Human-readable explanation specific to this occurrence of the\nproblem, if any extra detail is available.",
     "type": [
       "string",
       "null"
     ]
   },
   "status": {
     "description": "HTTP status code of the response, repeated here for convenience.",
     "type": "integer",
     "format": "int32",
     "minimum": 0.0,
     "example": 404
   },
   "title": {
     "description": "Short, human-readable summary of the problem type. Does not vary\nbetween occurrences of the same `type`.",
     "type": "string"
   },
   "type": {
     "description": "A URI reference identifying the problem type. Stable across\noccurrences of the same error, so callers can match on it.",
     "type": "string",
     "format": "uri",
     "example": "/errors/resource-not-found"
   }
 }
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§detail: Option<String>

Human-readable explanation specific to this occurrence of the problem, if any extra detail is available.

§status: i32

HTTP status code of the response, repeated here for convenience.

§title: String

Short, human-readable summary of the problem type. Does not vary between occurrences of the same type.

§type_: String

A URI reference identifying the problem type. Stable across occurrences of the same error, so callers can match on it.

Implementations§

Source§

impl ProblemDetailsSchema

Source

pub fn builder() -> ProblemDetailsSchemaBuilder

Create an instance of ProblemDetailsSchema using the builder syntax

Trait Implementations§

Source§

impl Clone for ProblemDetailsSchema

Source§

fn clone(&self) -> ProblemDetailsSchema

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProblemDetailsSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ProblemDetailsSchema

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ProblemDetailsSchema

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.