Struct ProviderResponseError 

pub struct ProviderResponseError {
    pub status: Option<StatusCode>,
    pub body: String,
    pub provider_request_id: Option<String>,
    pub headers: Option<HeaderMap>,
    pub code: Option<String>,
    pub transient: Option<bool>,
    pub refusal: bool,
    pub route: Option<String>,
}

A raw provider error body with captured transport metadata. Callers must supply the provider’s actual payload, not a generated diagnostic. Serialization omits headers and route; deserialization restores them as None.

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>

Transport request ID from response headers or SDK metadata, when captured.

headers: Option<HeaderMap>

Captured response headers, including rate-limit metadata. None means not captured, rather than an empty header set. Omitted during serialization.

code: Option<String>

The provider’s own machine-readable code for the failure, when the transport reported one apart from the body: a gRPC status code name (UNAVAILABLE), an AWS exception type (ThrottlingException). None when the reply carried only a status and a body.

transient: Option<bool>

Transport retry verdict used when status is absent or successful. A non-success HTTP status takes precedence; refusals are never retryable.

refusal: bool

Whether this error represents a content refusal. Refusals are never retryable; refusal content in a successful model answer is separate.

route: Option<String>

The provider and request path the reply answered, when the operation records them for diagnostics (model listing does). Omitted during serialization.

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_refusal(self, refusal: bool) -> Self

Mark the reply as the provider’s verdict on the content: a refusal, final, never retried.

pub fn with_status(self, status: Option<StatusCode>) -> Self

Attach the HTTP status a transport reported beside a reply that was first preserved without one (an SDK that hands back the raw HTTP response next to its typed exception). A status already set is kept.

pub fn with_code(self, code: Option<String>) -> Self

Attach the provider’s own machine-readable code for the failure.

pub fn with_transient(self, transient: Option<bool>) -> Self

Replaces the transport retry verdict. Used for absent or successful HTTP statuses unless the response is a refusal.

pub fn is_retryable(&self) -> bool

Returns false for refusals. Otherwise classifies non-success HTTP statuses through crate::error::retryable_status, or uses transient for absent or successful statuses. Missing verdicts default to false.

pub fn machine_code(&self) -> Option<String>

Returns the explicit code, falling back to nonempty string fields error.code, error.status, then error.type in the JSON body.

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<HeaderMap>) -> Self

Replaces captured response headers, including rate-limit metadata.

Trait Implementations

impl Clone for ProviderResponseError

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 ProviderResponseError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderResponseError

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProviderResponseError

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProviderResponseError