Struct ResponseError 

pub struct ResponseError {
    pub code: ResponseErrorCode,
    pub error: String,
    pub general_problem: Option<String>,
    pub kind: String,
    pub possible_fix: Option<String>,
    pub requirement: Option<String>,
    pub validation_errors: Option<Vec<ValidationError>>,
}

Fields

code: ResponseErrorCode

Class of error that has occurred or been detected.

error: String

general_problem: Option<String>

An English string with a broader/alternative description of the problem.

kind: String

possible_fix: Option<String>

An English string with hints to the API client developer. Consider this a micro-FAQ answer specific to the particular error case. Very unlikely to be suitable for direct presentation to a user.

requirement: Option<String>

An English string describing the constraint on the API that wasn’t met by the current request.

validation_errors: Option<Vec<ValidationError>>

In the case where the server detected one or more errors with regard to the value of specific individual parameters, rather than with the request as a whole, the error response hash may be augmented with parameter-specific error messages. These messages are packaged in an array of hashes, stored under the validation_errors key. Each validation error hash contains a field key with the name of a request parameter (resource attribute), and a problem key with an English string describing the error(s) detected in the value of that parameter.

Trait Implementations

impl Debug for ResponseError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseError> for RequestError

fn from(err: ResponseError) -> Self

Converts to this type from the input type.

impl Serialize for ResponseError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.