Enum Error 

#[non_exhaustive]
pub enum Error {
    Config(String),
    InvalidRequest(String),
    Api(Box<ApiError>),
    Connection {
        source: Error,
    },
    Timeout {
        timeout: Duration,
    },
    Decode {
        message: String,
        request_id: Option<String>,
        source: Option<Error>,
    },
    Credentials {
        source: BoxError,
    },
    UnexpectedAnswer {
        name: String,
        reason: String,
    },
}

Everything a client call can fail with.

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.

Config(String)

The client configuration is missing or invalid.

InvalidRequest(String)

The request was rejected before it was sent.

Api(Box<ApiError>)

The server answered with a non-2xx status after retries.

Connection

The request or the response body failed in transit (DNS, TLS, reset).

Fields

source: Error

The underlying transport error.

Timeout

The full response did not arrive within the per-attempt timeout.

Fields

timeout: Duration

The per-attempt timeout that elapsed.

Decode

A 2xx response body did not have the expected shape.

Fields

message: String

What was wrong with the body.

request_id: Option<String>

Request ID from x-typesafe-request-id.

source: Option<Error>

The JSON parse error, when there was one.

Credentials

The credential provider failed, timed out, or returned an unusable token.

The message never includes the token. Not retried.

Fields

source: BoxError

What went wrong.

UnexpectedAnswer

An answer is missing, has another type, or uses a label the typed key doesn’t know.

Fields

name: String

The question name.

reason: String

What didn’t match.

Implementations

impl Error

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

The HTTP status, for Error::Api.

pub fn request_id(&self) -> Option<&str>

The server’s request ID, when the response carried one.

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

The API error, for Error::Api.

pub fn is_timeout(&self) -> bool

Whether the call timed out.

pub fn is_connection(&self) -> bool

Whether the call failed in transit. Timeouts count as connection errors.

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, __formatter: &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.

impl From<ApiError> for Error

fn from(err: ApiError) -> Self

Converts to this type from the input type.