Enum ClientError 

pub enum ClientError {
    Http(Error),
    Api {
        status: Option<StatusCode>,
        message: String,
        error_type: Option<String>,
        code: Option<String>,
        param: Option<String>,
    },
    Serialization {
        source: Error,
        raw_payload: Option<String>,
    },
    Stream(String),
    MissingApiKey(String),
    InvalidUrl(String),
    InvalidHeader(String),
}

Errors that can occur when calling OpenAI and OpenRouter endpoints.

Variants

Http(Error)

Network or HTTP transport failure.

Api

The remote endpoint returned an error status code and payload.

Fields

status: Option<StatusCode>

HTTP response status code, if available.

message: String

Human-readable error message.

error_type: Option<String>

Error classification string.

code: Option<String>

Machine-readable error code.

param: Option<String>

Parameter that caused the error.

Serialization

JSON serialization or deserialization failure.

Fields

source: Error

Underlying serde_json error.

raw_payload: Option<String>

Raw unparsed payload if available for diagnostics.

Stream(String)

Server-Sent Events streaming error or protocol violation.

MissingApiKey(String)

An API key was required but not provided or found in the environment.

InvalidUrl(String)

The provided base URL or endpoint could not be parsed.

InvalidHeader(String)

An HTTP header value contains invalid characters.

Implementations

impl ClientError

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

Returns the HTTP status code if this error originated from an API response.

pub fn is_rate_limited(&self) -> bool

Returns true if the error represents an HTTP 429 Too Many Requests response or rate limit code.

pub fn is_transient(&self) -> bool

Returns true if the error is a transient server failure (HTTP 5xx, 408, or connection error).

Trait Implementations

impl Debug for ClientError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ClientError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ClientError

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 ClientError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(source: Error) -> Self

Converts to this type from the input type.