Enum Error 

#[non_exhaustive]
pub enum Error {
    Config {
        message: String,
        source: Option<BoxError>,
    },
    InvalidRequest {
        message: String,
        source: Option<BoxError>,
    },
    Api(Box<ApiError>),
    Connection(BoxError),
    Timeout(Duration),
    ResponseValidation(Box<ResponseValidationError>),
    ReplayMiss {
        key: String,
        path: PathBuf,
    },
}

Any failure produced by the SDK.

Display describes this error only; the cause, when there is one, is its source, so walk the chain to show all of it.

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

The client could not be configured (missing API key, invalid base URL, invalid timeout, invalid retry policy, a record or replay directory that cannot be used, or an async runtime that cannot be started).

Fields

message: String

What is wrong.

source: Option<BoxError>

The error that caused it, if any: the I/O error, the URL parse error, …

InvalidRequest

The request was rejected locally before being sent (no questions, empty choice or score criteria, malformed raw question, or a body that cannot be encoded as JSON).

Fields

message: String

What is wrong.

source: Option<BoxError>

The error that caused it, if any: the JSON encoding error, …

Api(Box<ApiError>)

The server returned an unsuccessful HTTP status after any retries.

Connection(BoxError)

The request could not reach the server or the response could not be read (DNS, connect, TLS, reset, body read). The underlying HTTP client’s error is available via source().

Timeout(Duration)

The request exceeded its configured timeout.

ResponseValidation(Box<ResponseValidationError>)

The server returned a successful status but the body is missing required data.

ReplayMiss

The client is replaying and this request was never recorded. Nothing was sent: a replaying client does not fall back to the network. Record it first (TYPESAFE_RECORD=<dir>); see crate::cassette.

Fields

key: String

The request’s cassette key.

path: PathBuf

The file that would have held the response.

Implementations

impl Error

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

The API error, if this is one.

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

The HTTP status associated with this error, if any.

use typesafe::{Error, StatusCode};

fn is_conflict(err: &Error) -> bool {
    err.status() == Some(StatusCode::CONFLICT)
}

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

The x-typesafe-request-id of the failing response, if any.

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.