Struct ApiError 

pub struct ApiError {
    pub code: ApiErrorCode,
    pub message: String,
    pub request_id: String,
    pub protocol_code: Option<String>,
}

Wire-format error payload returned by the JSON API.

Fields

code: ApiErrorCode

message: String

request_id: String

Opaque correlation id. Always present; clients should surface this when reporting a problem.

protocol_code: Option<String>

Optional protocol-specific subcode, e.g. OAuth error field.

Implementations

impl ApiError

pub fn new( code: ApiErrorCode, message: impl Into<String>, request_id: impl Into<String>, ) -> Self

pub fn with_protocol_code(self, sub: impl Into<String>) -> Self

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 Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

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.