Struct ErrorObject

pub struct ErrorObject {
    pub code: Option<String>,
    pub detail: Option<String>,
    pub id: Option<String>,
    pub links: Map<Key, Link>,
    pub meta: Map,
    pub source: Option<ErrorSource>,
    pub status: Option<StatusCode>,
    pub title: Option<String>,
    /* private fields */
}

Contains information about problems encountered while performing an operation.

For more information, check out the error objects section of the JSON API specification.

Fields

code: Option<String>

An application-specific error code, expressed as a string value.

detail: Option<String>

A human-readable explanation specific to this occurrence of the problem.

id: Option<String>

A unique identifier for this particular occurrence of the problem.

links: Map<Key, Link>

Contains relevant links. If this value of this field is empty, it will not be serialized. For more information, check out the links section of the JSON API specification.

meta: Map

Non-standard meta information. If this value of this field is empty, it will not be serialized. For more information, check out the meta information section of the JSON API specification.

source: Option<ErrorSource>

The source of the error.

status: Option<StatusCode>

The HTTP status code applicable to this problem.

title: Option<String>

A short, human-readable summary of the problem.

Implementations

impl ErrorObject

pub fn new(status: Option<StatusCode>) -> Self

Returns a new ErrorObject with the specified status.

Trait Implementations

impl Clone for ErrorObject

fn clone(&self) -> ErrorObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorObject

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

Formats the value using the given formatter.

impl Default for ErrorObject

fn default() -> ErrorObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ErrorObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ErrorObject

fn eq(&self, other: &ErrorObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ErrorObject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ErrorObject