Enum Error 

#[non_exhaustive]
pub enum Error {
    Api {
        status: u16,
        message: String,
    },
    InvalidBaseUrl(String),
    Http(Error),
    Json(Error),
    Base64(DecodeError),
    Stream(String),
}

Errors returned by the SDK.

Error::Api is the structured gateway error parsed from the canonical {"error":{"message":"..."}} envelope (see SPEC.md). Everything else is a transport or decoding failure.

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

A non-2xx response from the gateway, carrying its HTTP status and the error.message field from the envelope.

Status codes (per SPEC.md): 400 bad request · 401 missing/invalid key · 403 blocked or model-not-allowed · 404 no route for model · 429 key suspended (limiter) · 502 all upstreams failed.

Fields

status: u16

HTTP status code of the failed response.

message: String

Human-readable message from error.message.

InvalidBaseUrl(String)

The configured base URL could not be parsed.

Http(Error)

An HTTP / transport-level failure (connection, TLS, timeout, …).

Json(Error)

A JSON body could not be (de)serialised.

Base64(DecodeError)

A base64 embedding payload could not be decoded.

Stream(String)

The server sent a malformed SSE / NDJSON stream.

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

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.