Struct HttpError 

pub struct HttpError {
    pub kind: HttpErrorKind,
    pub method: Option<Method>,
    pub url: Option<Url>,
    pub status: Option<StatusCode>,
    pub message: String,
    pub response_body_preview: Option<String>,
    pub retry_after: Option<Duration>,
    pub source: Option<BoxError>,
}

Unified HTTP error type.

Fields

kind: HttpErrorKind

Error category.

method: Option<Method>

Optional HTTP method.

url: Option<Url>

Optional request URL.

status: Option<StatusCode>

Optional response status code.

message: String

Human-readable message.

response_body_preview: Option<String>

Optional preview of non-success response body.

retry_after: Option<Duration>

Optional Retry-After duration parsed from a non-success response.

source: Option<BoxError>

Optional source error.

Implementations

impl HttpError

pub fn new(kind: HttpErrorKind, message: impl Into<String>) -> Self

Creates an error with kind and message; other fields are unset until chained.

Parameters

• kind: Classification for retry logic and handling.
• message: Human-readable description.

Returns

New HttpError.

pub fn with_method(self, method: Method) -> Self

Attaches the HTTP method for diagnostics.

Parameters

• method: Request method associated with the failure.

Returns

self for chaining.

pub fn with_url(self, url: Url) -> Self

Attaches the request URL for diagnostics.

Parameters

• url: Request URL associated with the failure.

Returns

self for chaining.

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

Attaches an HTTP status code (e.g. for HttpErrorKind::Status).

Parameters

• status: Response status code.

Returns

self for chaining.

pub fn with_source<E>(self, source: E) -> Self

where E: Error + Send + Sync + 'static,

Wraps an underlying error as the HttpError::source chain.

Parameters

• source: Root cause (Send + Sync + 'static).

Returns

self for chaining.

pub fn with_response_body_preview(self, preview: impl Into<String>) -> Self

Attaches a preview of the non-success response body.

Parameters

• preview: Truncated or summarized response body text.

Returns

self for chaining.

pub fn with_retry_after(self, retry_after: Duration) -> Self

Attaches parsed Retry-After duration from a non-success response.

Parameters

• retry_after: Parsed retry delay.

Returns

self for chaining.

pub fn invalid_url(message: impl Into<String>) -> Self

Builds HttpErrorKind::InvalidUrl.

Parameters

• message: Why the URL is invalid or cannot be resolved.

Returns

New HttpError.

pub fn build_client(message: impl Into<String>) -> Self

Builds HttpErrorKind::BuildClient (e.g. reqwest builder failure).

Parameters

• message: Build failure description.

Returns

New HttpError.

pub fn proxy_config(message: impl Into<String>) -> Self

Builds HttpErrorKind::ProxyConfig.

Parameters

• message: Invalid proxy settings explanation.

Returns

New HttpError.

pub fn connect_timeout(message: impl Into<String>) -> Self

Builds HttpErrorKind::ConnectTimeout.

Parameters

• message: Timeout context.

Returns

New HttpError.

pub fn read_timeout(message: impl Into<String>) -> Self

Builds HttpErrorKind::ReadTimeout.

Parameters

• message: Timeout context.

Returns

New HttpError.

pub fn write_timeout(message: impl Into<String>) -> Self

Builds HttpErrorKind::WriteTimeout.

Parameters

• message: Timeout context.

Returns

New HttpError.

pub fn request_timeout(message: impl Into<String>) -> Self

Builds HttpErrorKind::RequestTimeout.

Parameters

• message: Timeout context for the whole request deadline.

Returns

New HttpError.

pub fn transport(message: impl Into<String>) -> Self

Builds HttpErrorKind::Transport.

Parameters

• message: Low-level I/O or network failure description.

Returns

New HttpError.

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

Builds HttpErrorKind::Status with the given status pre-filled.

Parameters

• status: HTTP status from the response.
• message: Additional context.

Returns

New HttpError with HttpError::status set.

pub fn decode(message: impl Into<String>) -> Self

Builds HttpErrorKind::Decode (body or payload decoding).

Parameters

• message: Decode failure description.

Returns

New HttpError.

pub fn sse_protocol(message: impl Into<String>) -> Self

Builds HttpErrorKind::SseProtocol (framing, UTF-8, SSE line rules).

Parameters

• message: Protocol violation description.

Returns

New HttpError.

pub fn sse_decode(message: impl Into<String>) -> Self

Builds HttpErrorKind::SseDecode (e.g. JSON in SSE data).

Parameters

• message: Payload decode failure description.

Returns

New HttpError.

pub fn cancelled(message: impl Into<String>) -> Self

Builds HttpErrorKind::Cancelled.

Parameters

• message: Why the operation was cancelled.

Returns

New HttpError.

pub fn other(message: impl Into<String>) -> Self

Builds HttpErrorKind::Other.

Parameters

• message: Catch-all description.

Returns

New HttpError.

pub fn retry_hint(&self) -> RetryHint

Classifies this error for retry policies (RetryHint).

Returns

RetryHint::Retryable for timeouts, transport errors, and some HTTP statuses; otherwise non-retryable.

Trait Implementations

impl Debug for HttpError

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

Formats the value using the given formatter.

impl Display for HttpError

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

Formats the value using the given formatter.

impl Error for HttpError

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<Error> for HttpError

fn from(error: Error) -> Self

Maps std::io::Error to HttpError::transport with the I/O error as source.

Parameters

• error: Underlying I/O error.

Returns

Wrapped HttpError.

impl From<Error> for HttpError

fn from(error: Error) -> Self

Maps reqwest::Error to HttpErrorKind::BuildClient with chained source.

Parameters

• error: Reqwest error to wrap.

Returns

Wrapped HttpError.