Enum CompletionErrorKind 

#[non_exhaustive]
pub enum CompletionErrorKind {
    ContextOverflow,
    RateLimited,
    QuotaExhausted,
    Overloaded,
    Refused,
    Timeout,
    Transport,
    ServerError,
    Rejected,
    MalformedResponse,
    EmptyReply,
    Unavailable,
}

The kind of failure a model round ended with.

The kinds form a closed set, so a caller can branch on the kind alone. The caller that performs a round maps every failure into one of these kinds. Each kind is either retryable or permanent (see CompletionError::is_retryable). The enum is #[non_exhaustive], so a match on it needs a wildcard arm.

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.

ContextOverflow

The request exceeds the model’s context window. Permanent.

RateLimited

The backend is limiting the request rate. Retryable.

QuotaExhausted

The billing or usage quota is spent. Permanent.

Overloaded

The backend is temporarily at capacity. Retryable.

Refused

The provider declined the content on policy grounds. Permanent.

Timeout

The wait for a reply or the next chunk timed out. Retryable.

Transport

The connection failed or the stream broke. Retryable.

ServerError

The backend reported a fault of its own. Retryable.

Rejected

The backend refused the request for any other reason. Permanent.

MalformedResponse

The reply was malformed, or it was larger than the size limit for a reply. Retryable.

EmptyReply

The model’s reply was empty of text and tool calls. Permanent.

Unavailable

Model access is turned off or lacks a configuration. Permanent.

Implementations

impl CompletionErrorKind

pub fn phrase(self) -> &'static str

Returns the fixed phrase for this kind: one lowercase phrase written for a model to read.

The caller builds a CompletionError message from this phrase. For a failure that came from an HTTP status, it appends (status N). A 401 or 403 is Unavailable, and its message uses the phrase the model backend did not accept the credentials. Only MalformedResponse, EmptyReply, and Unavailable may extend the phrase with : and specific text that the caller’s own code wrote. Provider text never enters the message. It goes in the detail.

Trait Implementations

impl Clone for CompletionErrorKind

fn clone(&self) -> CompletionErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompletionErrorKind

impl Debug for CompletionErrorKind

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

Formats the value using the given formatter.

impl Eq for CompletionErrorKind

impl Hash for CompletionErrorKind

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CompletionErrorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompletionErrorKind