Enum Error 

#[non_exhaustive]
pub enum Error {
    Api(Box<ApiError>),
    Job(Box<JobError>),
    Timeout {
        job_id: Option<Uuid>,
    },
    Transport(Error),
    Decode {
        status: Option<u16>,
        message: String,
    },
    Config(String),
    InvalidRequest(String),
    Io {
        path: PathBuf,
        source: Error,
    },
}

Every way an SDK call can fail.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Api(Box<ApiError>)

The API refused the request (a non-2xx response).

Job(Box<JobError>)

The job finished failed or canceled.

Timeout

A wait ran out of time. The job is NOT canceled and keeps running (and is billed); wait again, or cancel it.

Fields

job_id: Option<Uuid>

The job still running, when there is one.

Transport(Error)

The request never got a response (DNS, TLS, connection, timeout). The URL is stripped: signed URLs carry credentials in the query string.

Decode

A success response whose body did not decode.

Fields

status: Option<u16>

The HTTP status of the response.

message: String

What went wrong.

Config(String)

The client could not be built (missing API key, bad header value, …).

InvalidRequest(String)

A request the SDK refused to send (for example a request builder with a missing required field).

Io

A file could not be read or written.

Fields

path: PathBuf

The path involved.

source: Error

The filesystem error.

Implementations

impl Error

pub fn code(&self) -> Option<&ErrorCode>

The API’s machine-readable code, from a refusal or a failed job.

pub fn status(&self) -> Option<u16>

The HTTP status of a refusal.

pub fn as_api(&self) -> Option<&ApiError>

The refusal, when this is one.

pub fn as_job(&self) -> Option<&JobError>

The failed or canceled job, when this is one.

pub fn is_out_of_credits(&self) -> bool

See ApiError::is_out_of_credits; also true for a job that failed with out_of_credits.

pub fn is_plan_required(&self) -> bool

See ApiError::is_plan_required.

pub fn is_rate_limited(&self) -> bool

See ApiError::is_rate_limited.

pub async fn from_api(err: Error<()>) -> Self

Convert an error from a generated (api) call, reading the refusal body when there is one. crate::Typed::typed does this for you.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.