Struct OpenAIError 

pub struct OpenAIError {
    pub kind: ErrorKind,
    pub message: String,
    /* private fields */
}

Top-level shared runtime error.

Fields

kind: ErrorKind

Error classification.

message: String

Human-readable message.

Implementations

impl OpenAIError

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self

Creates a new error with the given classification.

pub fn with_response_metadata( self, status_code: u16, headers: BTreeMap<String, String>, request_id: Option<String>, ) -> Self

Attaches response metadata to the error.

pub fn with_api_error(self, api_error: ApiErrorPayload) -> Self

Attaches a parsed API error payload.

pub fn with_source<E>(self, source: E) -> Self

where E: Error + Send + Sync + 'static,

Attaches a source error.

pub fn status_code(&self) -> Option<u16>

Returns the HTTP status code when available.

pub fn request_id(&self) -> Option<&str>

Returns the surfaced request id when available.

pub fn header(&self, name: &str) -> Option<&str>

Returns a lower-cased response header by name.

pub fn api_error(&self) -> Option<&ApiErrorPayload>

Returns the parsed API error payload when available.

pub fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the underlying source error when available.

Trait Implementations

impl Clone for OpenAIError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenAIError

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

Formats the value using the given formatter.

impl Display for OpenAIError

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

Formats the value using the given formatter.

impl Error for OpenAIError

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.