Enum Error 

#[non_exhaustive]
pub enum Error {
    Auth(String),
    TokenLimit(String),
    InvalidRequest(String),
    InvalidConfig(String),
    Api(String),
}

Why a client could not be built, or a request could not be answered.

Transient failures (connection errors, HTTP 429, 5xx) are retried inside Client::ask and only surface as Error::Api once the retries are spent. The other variants are returned at once, because retrying cannot help.

The enum is #[non_exhaustive]: a later version may tell more failures apart, so a match needs a wildcard arm. Error::message and Display give the text of any variant.

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.

Auth(String)

Missing, blank, unsendable or rejected credentials (HTTP 401 or 403).

TokenLimit(String)

The request exceeded the model’s context (max_tokens_exceeded, or HTTP 413). Ask fewer questions, or about less state, and retry.

InvalidRequest(String)

A request the API would not evaluate: a state that does not serialize to JSON, or a body the API refused as malformed (HTTP 422), such as a Score with a single level or a state that is a bare number. The message quotes what the API objected to.

InvalidConfig(String)

A Config no request could be sent with: a base URL that is not an absolute http or https URL, or a user agent that is not a valid header value. Reported by Client::new, before anything is sent.

Api(String)

Anything else: an unreadable response, an unexpected status, or retries exhausted.

Implementations

impl Error

pub fn message(&self) -> &str

The message, without the variant.

Trait Implementations

impl Clone for Error

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 Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Error