Skip to main content

ProblemDetail

Struct ProblemDetail 

Source
pub struct ProblemDetail {
    pub error_type: String,
    pub title: String,
    pub status: u16,
    pub detail: String,
    pub instance: Option<String>,
    pub code: ErrorCode,
    pub retryable: bool,
    pub details: HashMap<String, Value>,
}
Expand description

RFC 9457 Problem Details — the single canonical error response envelope for transport error responses in rskit.

Serialises to:

{
  "type": "https://rskit.dev/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "user '42' not found",
  "code": "NOT_FOUND",
  "retryable": false
}

Fields§

§error_type: String

URI reference that identifies the problem type (RFC 9457 §3.1.1).

§title: String

Short, human-readable summary of the problem type (RFC 9457 §3.1.2).

§status: u16

HTTP status code (RFC 9457 §3.1.3).

§detail: String

Human-readable explanation specific to this occurrence (RFC 9457 §3.1.4).

§instance: Option<String>

URI reference identifying this specific occurrence (RFC 9457 §3.1.5).

§code: ErrorCode

Machine-readable error code (rskit extension).

§retryable: bool

Whether the operation that produced this error is safe to retry (rskit extension).

§details: HashMap<String, Value>

Arbitrary key-value pairs providing additional context (rskit extension).

Trait Implementations§

Source§

impl Clone for ProblemDetail

Source§

fn clone(&self) -> ProblemDetail

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 ProblemDetail

Source§

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

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

impl<'de> Deserialize<'de> for ProblemDetail

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 From<&AppError> for ProblemDetail

Source§

fn from(err: &AppError) -> Self

Converts to this type from the input type.
Source§

impl From<AppError> for ProblemDetail

Source§

fn from(err: AppError) -> Self

Converts to this type from the input type.
Source§

impl Serialize for ProblemDetail

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.