Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidConfig(&'static str),
    InvalidRequest(&'static str),
    InvalidResponse(&'static str),
    Transport(Box<dyn Error + Send + Sync>),
    Encode(Error),
    Protocol(Error),
    Timeout,
    ResponseTooLarge,
    Http {
        status: u16,
        body: Value,
        retry_after: Option<String>,
    },
}

Typed SDK failures. Display and Debug omit response bodies and transport details.

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.

InvalidConfig(&'static str)

Invalid URL, timeout, response limit or bearer token.

InvalidRequest(&'static str)

Invalid typed question or ergonomic request.

InvalidResponse(&'static str)

A typed response is missing required fields or contradicts its question schema.

Transport(Box<dyn Error + Send + Sync>)

Connection or response-body failure. Original details are available explicitly through Error::source.

Encode(Error)

Request JSON serialization failure.

Protocol(Error)

Successful response did not match the native JSON contract.

Timeout

Entire request (including body read) exceeded its deadline.

ResponseTooLarge

Actual streamed response exceeds the configured limit.

Http

Non-success response, including native validation 422 and overload 529.

Fields

status: u16

HTTP status code.

body: Value

JSON error body, or a JSON string holding a non-JSON response. Explicit access only.

retry_after: Option<String>

Unmodified Retry-After; no automatic retry.

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<Error> for BatchOperationError

fn from(value: Error) -> Self

Converts to this type from the input type.