Enum Error 

#[non_exhaustive]
pub enum Error {
    Config(String),
    InvalidRequest(String),
    Api(Box<ApiError>),
    Connection {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Timeout {
        timeout: Duration,
    },
    ResponseValidation {
        status: u16,
        field_path: String,
        request_id: Option<String>,
        endpoint: String,
    },
}

Every error this crate can return.

The API key never appears in any error. The top-level error is #[non_exhaustive]: match on the variants you handle and keep a wildcard arm for forward compatibility.

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 could not be constructed: a missing, empty, or invalid API key, an invalid timeout, or invalid retry policy settings.

InvalidRequest(String)

The request failed client-side validation before any network I/O.

Api(Box<ApiError>)

The server returned a non-2xx response.

Connection

The error variant: no HTTP response arrived.

Fields

message: String

Description of the transport failure.

source: Option<Box<dyn Error + Send + Sync>>

The underlying transport error, when available.

Timeout

The attempt exceeded the per-attempt timeout. A kind of connection error.

Fields

timeout: Duration

The per-attempt timeout that expired.

ResponseValidation

A 2xx response body did not match the expected schema.

Fields

status: u16

HTTP status of the offending response.

field_path: String

Dotted path to the first missing or invalid field, e.g. answers.tone.confidence; "" for a non-object body.

request_id: Option<String>

x-typesafe-request-id of the offending response, when present.

endpoint: String

"<METHOD> <URL>" of the request.

Implementations

impl Error

pub fn is_timeout(&self) -> bool

Returns true when this error is a timeout.

pub fn is_connection(&self) -> bool

Returns true when this error is a connection error. Timeouts count as connection errors.

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

Returns the HTTP status code when this error came from a response.

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

Returns the x-typesafe-request-id when this error came from a response.

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

Returns the underlying ApiError when this is a non-2xx response error.

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.

impl From<ApiError> for Error

fn from(error: ApiError) -> Self

Converts to this type from the input type.