Enum Error 

pub enum Error {
    Protocol(Error),
    InvalidStatusCode(StatusCode),
    InvalidStatusCodeWithMessage(StatusCode, String),
    InvalidStatusCodeWithDetails {
        status: StatusCode,
        body: String,
        headers: Box<HeaderMap>,
    },
    InvalidHeaderValue(InvalidHeaderValue),
    NoHeaders,
    StreamEnded,
    InvalidContentType(HeaderValue),
    Instance(Box<dyn Error + Send + Sync + 'static>),
}

Variants

Protocol(Error)

InvalidStatusCode(StatusCode)

InvalidStatusCodeWithMessage(StatusCode, String)

InvalidStatusCodeWithDetails

A non-success HTTP response whose headers were preserved alongside the body, so provider layers can read transport metadata — e.g. their request-id contract — off the failed response (rig#2314). Displays identically to Self::InvalidStatusCodeWithMessage.

Fields

status: StatusCode

The non-success status.

body: String

The raw response body.

headers: Box<HeaderMap>

The failed response’s headers, verbatim.

InvalidHeaderValue(InvalidHeaderValue)

NoHeaders

StreamEnded

InvalidContentType(HeaderValue)

Instance(Box<dyn Error + Send + Sync + 'static>)

Available on non-target_family=wasm only.

Implementations

impl Error

pub fn non_success_headers(&self) -> Option<&HeaderMap>

Returns the failed response’s headers, when this error preserved them.

Rig’s bundled HTTP clients capture the full HeaderMap whenever a non-success status error is built from a live response, so rate-limit metadata such as Retry-After or x-ratelimit-* stays readable (rig#2210). This is the accessor a retry::RetryPolicy uses to honor a server-supplied backoff, since it is handed this error directly:

fn retry_after(error: &Error) -> Option<Duration> {
    let seconds = error
        .non_success_headers()?
        .get(http::header::RETRY_AFTER)?
        .to_str()
        .ok()?
        .parse()
        .ok()?;
    Some(Duration::from_secs(seconds))
}

Returns None when the error carries no captured headers: transports that report a non-success status without them, and errors built from only a status and body.

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<Box<dyn Error + Send + Sync>> for Error

fn from(source: Box<dyn Error + Send + Sync + 'static>) -> Self

Converts to this type from the input type.

impl From<Error> for AudioGenerationError

Available on crate feature audio only.

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for VerifyError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ProviderClientError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CompletionError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EmbeddingError

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 ImageGenerationError

Available on crate feature image only.

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ModelListingError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RerankError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TranscriptionError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for Error

fn from(source: InvalidHeaderValue) -> Self

Converts to this type from the input type.