Struct ApiCallError 

pub struct ApiCallError {
    pub message: String,
    pub url: Url,
    pub request_body: Option<JsonValue>,
    pub status_code: Option<StatusCode>,
    pub response_headers: Option<Headers>,
    pub response_body: Option<String>,
    pub is_retryable: bool,
    pub data: Option<JsonValue>,
    pub cause: Option<BoxError>,
}

An HTTP request to the provider failed or returned an error status.

Fields

message: String

Human-readable message (no secrets, no full bodies).

url: Url

Request URL.

request_body: Option<JsonValue>

JSON request body that was sent, if any.

status_code: Option<StatusCode>

HTTP status code, if a response was received.

response_headers: Option<Headers>

Response headers, if a response was received.

response_body: Option<String>

Raw response body text, if a response was received.

is_retryable: bool

Whether retrying may succeed.

data: Option<JsonValue>

Structured error payload parsed from the response, if any.

cause: Option<BoxError>

Underlying cause (network error, JSON error, …).

Implementations

impl ApiCallError

pub fn new(message: impl Into<String>, url: Url) -> Self

Creates an error without a response; retryable by default.

pub fn with_status(self, status_code: StatusCode) -> Self

Sets the status code and recomputes the default retry classification.

pub fn with_request_body(self, body: JsonValue) -> Self

Sets the request body.

pub fn with_response(self, headers: Headers, body: Option<String>) -> Self

Sets response headers and body.

pub fn with_data(self, data: JsonValue) -> Self

Sets the structured error payload.

pub fn with_cause(self, cause: impl Error + Send + Sync + 'static) -> Self

Sets the underlying cause.

pub fn retryable(self, is_retryable: bool) -> Self

Overrides the retry classification.

Trait Implementations

impl Debug for ApiCallError

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

Formats the value using the given formatter.

impl Display for ApiCallError

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

Formats the value using the given formatter.

impl Error for ApiCallError

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<ApiCallError> for ProviderError

fn from(error: ApiCallError) -> Self

Converts to this type from the input type.

impl From<Box<ApiCallError>> for ProviderError

fn from(error: Box<ApiCallError>) -> Self

Converts to this type from the input type.