Struct ProviderResponseError 

pub struct ProviderResponseError {
    pub status: Option<StatusCode>,
    pub body: String,
    pub provider_request_id: Option<String>,
    pub headers: Option<Box<HeaderMap>>,
}

A raw error response preserved from a provider.

Capability errors store this in their ProviderResponse variants when Rig has the provider’s response body in hand. Unlike ProviderError(String), which may carry Rig-generated diagnostics, this type always represents the payload the provider actually returned.

Prefer Self::new / Self::without_status and the with_* setters over a struct literal: a literal has to be revisited every time transport metadata grows, and the constructors do not.

Fields

status: Option<StatusCode>

HTTP status of the provider response, when it was captured alongside the body.

body: String

Raw response body as returned by the provider.

provider_request_id: Option<String>

The provider’s transport request id for the failed call (HTTP response header such as Anthropic request-id / OpenAI x-request-id, or SDK response metadata) — the id provider support asks for when investigating a request, which matters most on exactly these failed calls. None means the provider did not report one — a documented outcome, never a secondary error (rig#2314).

headers: Option<Box<HeaderMap>>

The response’s headers, verbatim, when the capture path had them in hand — the rate-limit metadata (Retry-After, x-ratelimit-*) a caller needs to back off correctly after a 429 (rig#2210). Boxed to keep this error small enough for clippy::result_large_err. None means “not captured”, never “the response had no headers”.

Implementations

impl ProviderResponseError

pub fn new(status: StatusCode, body: impl Into<String>) -> Self

Preserve a provider error response captured with its HTTP status.

pub fn without_status(body: impl Into<String>) -> Self

Preserve a provider error body that has no HTTP status (gRPC / SDK transports).

pub fn with_provider_request_id(self, request_id: Option<String>) -> Self

Attach the transport request id the failed response reported.

pub fn with_headers(self, headers: Option<Box<HeaderMap>>) -> Self

Attach the response’s headers, so rate-limit metadata survives onto the error (rig#2210).

Trait Implementations

impl Clone for ProviderResponseError

fn clone(&self) -> ProviderResponseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderResponseError

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

Formats the value using the given formatter.

impl Display for ProviderResponseError

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

Formats the value using the given formatter.

impl Eq for ProviderResponseError

impl Error for ProviderResponseError

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 ProviderResponseError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProviderResponseError