Struct ApiError 

pub struct ApiError {
    pub error: Option<String>,
    pub status: String,
}

Standardized error response for the API

JSON schema

{
 "description": "Standardized error response for the API",
 "examples": [
   {
     "error": "Invalid value passed in parameter 'XYZ'",
     "status": "INVALID_INPUT"
   }
 ],
 "type": "object",
 "required": [
   "status"
 ],
 "properties": {
   "error": {
     "examples": [
       "Invalid value passed in parameter 'XYZ'"
     ],
     "type": [
       "string",
       "null"
     ]
   },
   "status": {
     "examples": [
       "INVALID_INPUT"
     ],
     "type": "string"
   }
 }
}

Fields

error: Option<String>

status: String

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.