Struct ErrorResponse 

pub struct ErrorResponse {
    pub message: String,
    pub error_code: Cow<'static, str>,
    pub details: Value,
}

Information returned by REST API endpoints on error.

Fields

message: String

Human-readable error message.

error_code: Cow<'static, str>

Error code is a string that specifies this error type.

details: Value

Detailed error metadata. The contents of this field is determined by error_code.

Implementations

impl ErrorResponse

pub fn from_error<E>(error: &E) -> Self

where E: DetailedError,

pub fn from_error_nolog<E>(error: &E) -> Self

where E: DetailedError,

Trait Implementations

impl Clone for ErrorResponse

fn clone(&self) -> ErrorResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E> From<&E> for ErrorResponse

where E: DetailedError,

fn from(error: &E) -> ErrorResponse

Transform the detailed error to a complete JSON error response.

• The message is retrieved using to_string() (available due to trait StdError)
• The status code determines the level of the log statement during this function (available due to trait ResponseError)
• The details are retrieved by serializing to JSON (available due to trait Serialize)

impl PartialEq for ErrorResponse

fn eq(&self, other: &ErrorResponse) -> 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 ErrorResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for ErrorResponse

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for ErrorResponse

impl StructuralPartialEq for ErrorResponse