Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub status: u16,
    pub code: String,
    pub message: String,
    pub fields: HashMap<String, Vec<String>>,
    pub retry_after: Option<Duration>,
}

A request the API refused.

code is the API’s: invalid_api_key, insufficient_scope, insufficient_credits, missing image, invalid_image, invalid_option, image_too_large, no_plate, not_found, image_unavailable, rate_limited, engine_unavailable or storage_unavailable. fields says, when the API names them, what is wrong with each field (empty otherwise). retry_after is how long to wait on a 429.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: u16

The HTTP status.

code: String

The API’s code for the refusal.

message: String

What went wrong, for a person to read.

fields: HashMap<String, Vec<String>>

The problems of each field of the request, when the API names them.

retry_after: Option<Duration>

How long to wait before trying again.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> Self

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

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

Formats the value using the given formatter.

impl Eq for ApiError

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 From<ApiError> for Error

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl PartialEq for ApiError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiError