Enum ClientError 

#[non_exhaustive]
pub enum ClientError {
    NetworkError(Error),
    MiddlewareError(Error),
    SerializationError(Error),
    AuthenticationError(String),
    EventSourceError(Error),
    RateLimitError {
        retry_after: Option<Duration>,
    },
    ModelError(String),
    ConfigurationError(String),
    TimeoutError,
    InvalidRequest(String),
    InvalidResponse(String),
    ToolsNotSupported,
    StreamingNotSupported,
    ContextLengthExceeded {
        current_tokens: usize,
        max_tokens: usize,
    },
    ContentFiltered {
        reason: String,
    },
    ServiceUnavailable(String),
    InvalidTemperature,
    InvalidTopP,
    InvalidFrequencyPenalty,
}

Errors that can occur when interacting with LLM APIs.

This enum covers all error conditions from network failures to API-specific errors like rate limiting and content filtering.

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.

NetworkError(Error)

Network or HTTP request failure.

Indicates issues like DNS resolution, connection failures, or socket errors. These errors are typically retryable.

MiddlewareError(Error)

Middleware layer error.

Errors from request/response middleware such as retry logic or logging.

SerializationError(Error)

JSON serialization or deserialization error.

Occurs when request/response JSON cannot be properly encoded or decoded.

AuthenticationError(String)

API authentication failure (HTTP 401).

The API key is missing, invalid, or revoked. Check your credentials.

EventSourceError(Error)

use reqwest_eventsource::{Error as EventSourceError};

RateLimitError

Rate limit exceeded (HTTP 429).

Too many requests sent in a given time period. Wait and retry.

Fields

retry_after: Option<Duration>

Suggested wait time before retrying, if provided by the API.

ModelError(String)

Model-specific error from the API.

The model encountered an error during generation.

ConfigurationError(String)

Client configuration issue.

Invalid base URL, missing required fields, or incompatible settings.

TimeoutError

Request timeout.

The request took longer than the configured timeout. Consider increasing the timeout or reducing request complexity.

InvalidRequest(String)

Malformed request.

The request structure is invalid or missing required parameters.

InvalidResponse(String)

Unexpected or malformed API response.

The API returned data that doesn’t match the expected format.

ToolsNotSupported

Tools requested but not supported by this model.

The model or provider doesn’t support function calling.

StreamingNotSupported

Streaming requested but not supported.

The model or provider doesn’t support streaming responses.

ContextLengthExceeded

Token limit exceeded for this model.

The input plus requested output exceeds the model’s context window.

Fields

current_tokens: usize

Current number of tokens in the request.

max_tokens: usize

Maximum tokens allowed by the model.

ContentFiltered

Content blocked by safety filter.

The content violates the provider’s usage policies.

Fields

reason: String

Reason for filtering (e.g., “violence”, “hate_speech”).

ServiceUnavailable(String)

API service unavailable (5xx errors).

The provider’s servers are experiencing issues. Retry with backoff.

InvalidTemperature

Temperature parameter out of valid range.

Temperature must be between 0.0 and 2.0.

InvalidTopP

top_p parameter out of valid range.

top_p must be between 0.0 and 1.0.

InvalidFrequencyPenalty

frequency_penalty parameter out of valid range.

frequency_penalty must be between -2.0 and 2.0.

Implementations

impl ClientError

pub fn is_retryable(&self) -> bool

Check if this error is potentially retryable.

Returns true for network errors, timeouts, rate limits, and service unavailable errors.

pub fn is_authentication_error(&self) -> bool

Check if this is an authentication error.

pub fn is_rate_limit_error(&self) -> bool

Check if this is a rate limit error.

pub fn retry_after(&self) -> Option<Duration>

Get the retry-after duration if this is a rate limit error.

Returns the suggested wait time before retrying the request.

Trait Implementations

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

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) -> ClientError

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(source: Error) -> ClientError

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(source: Error) -> ClientError

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(source: Error) -> ClientError

Converts to this type from the input type.