Enum Error 

pub enum Error {
    InvalidRequest(String),
    Authentication(String),
    RateLimit(String),
    Http(Error),
    HttpMiddleware(Error),
    Json(Error),
    Api {
        status: u16,
        message: String,
        error_type: Option<String>,
        error_code: Option<String>,
    },
    StreamConnection {
        message: String,
    },
    StreamParsing {
        message: String,
        chunk: String,
    },
    StreamBuffer {
        message: String,
    },
    Stream(String),
    File(Error),
    Config(String),
    Builder(String),
    Internal(String),
}

Main error type for the OpenAI ergonomic wrapper.

Variants

InvalidRequest(String)

Invalid request parameters or configuration.

Authentication(String)

Authentication errors.

RateLimit(String)

Rate limiting errors.

Http(Error)

HTTP client errors.

HttpMiddleware(Error)

HTTP middleware errors.

Json(Error)

JSON serialization/deserialization errors.

Api

OpenAI API errors with status code and message.

Fields

status: u16

HTTP status code returned by the API

message: String

Error message from the API

error_type: Option<String>

Type of error (if provided by API)

error_code: Option<String>

Error code (if provided by API)

StreamConnection

Streaming connection errors.

Fields

message: String

Error message describing the connection issue

StreamParsing

Streaming data parsing errors.

Fields

message: String

Error message describing the parsing issue

chunk: String

The problematic chunk data

StreamBuffer

Streaming buffer management errors.

Fields

message: String

Error message describing the buffer issue

Stream(String)

Generic streaming errors.

File(Error)

File operation errors.

Config(String)

Configuration errors.

Builder(String)

Builder validation errors.

Internal(String)

Generic internal errors.

Implementations

impl Error

pub fn api(status: u16, message: impl Into<String>) -> Self

Create a new API error with status and message.

pub fn api_detailed( status: u16, message: impl Into<String>, error_type: Option<String>, error_code: Option<String>, ) -> Self

Create a new API error with full details.

pub fn is_rate_limit(&self) -> bool

Check if this is a rate limit error.

pub fn is_auth_error(&self) -> bool

Check if this is an authentication error.

pub fn is_client_error(&self) -> bool

Check if this is a client error (4xx status codes).

pub fn is_server_error(&self) -> bool

Check if this is a server error (5xx status codes).

pub fn is_retryable(&self) -> bool

Check if this error might be retryable.

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<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.

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.