Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidUri {
        uri: String,
    },
    InvalidNoProxyRule {
        rule: String,
    },
    InvalidProxyConfig {
        proxy_uri: String,
        message: String,
    },
    ProxyAuthorizationRequiresHttpProxy,
    InvalidAdaptiveConcurrencyPolicy {
        min_limit: usize,
        initial_limit: usize,
        max_limit: usize,
        message: &'static str,
    },
    SerializeJson {
        source: Error,
    },
    SerializeQuery {
        source: Error,
    },
    SerializeForm {
        source: Error,
    },
    RequestBuild {
        source: Error,
    },
    Transport {
        kind: TransportErrorKind,
        method: Method,
        uri: String,
        message: String,
        source: Box<dyn Error + Send + Sync>,
    },
    Timeout {
        phase: TimeoutPhase,
        timeout_ms: u128,
        method: Method,
        uri: String,
    },
    DeadlineExceeded {
        timeout_ms: u128,
        method: Method,
        uri: String,
    },
    ReadBody {
        source: Box<dyn Error + Send + Sync>,
    },
    WriteBody {
        method: Method,
        uri: String,
        source: Box<dyn Error + Send + Sync>,
    },
    ResponseBodyTooLarge {
        limit_bytes: usize,
        actual_bytes: usize,
        method: Method,
        uri: String,
    },
    HttpStatus {
        status: u16,
        method: Method,
        uri: String,
        headers: Box<HeaderMap>,
        body: String,
    },
    DeserializeJson {
        source: Error,
        body: String,
    },
    DecodeText {
        source: Utf8Error,
        body: String,
    },
    InvalidHeaderName {
        name: String,
        source: InvalidHeaderName,
    },
    InvalidHeaderValue {
        name: String,
        source: InvalidHeaderValue,
    },
    DecodeContentEncoding {
        encoding: String,
        method: Method,
        uri: String,
        message: String,
    },
    ConcurrencyLimitClosed,
    TlsBackendUnavailable {
        backend: &'static str,
    },
    TlsBackendInit {
        backend: &'static str,
        message: String,
    },
    TlsConfig {
        backend: &'static str,
        message: String,
    },
    RetryBudgetExhausted {
        method: Method,
        uri: String,
    },
    CircuitOpen {
        method: Method,
        uri: String,
        retry_after_ms: u128,
    },
    MissingRedirectLocation {
        status: u16,
        method: Method,
        uri: String,
    },
    InvalidRedirectLocation {
        location: String,
        method: Method,
        uri: String,
    },
    RedirectLimitExceeded {
        max_redirects: usize,
        method: Method,
        uri: String,
    },
    RedirectBodyNotReplayable {
        method: Method,
        uri: String,
    },
}

Error returned by reqx.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidUri

The base URL or request URI was invalid.

Fields

uri: String

Invalid URI string.

InvalidNoProxyRule

A no_proxy rule could not be parsed.

Fields

rule: String

Original invalid rule string.

InvalidProxyConfig

Proxy configuration was internally inconsistent.

Fields

proxy_uri: String

Redacted proxy URI.

message: String

Human-readable validation message.

ProxyAuthorizationRequiresHttpProxy

proxy_authorization(...) was used without configuring http_proxy(...).

InvalidAdaptiveConcurrencyPolicy

Adaptive concurrency settings were invalid.

Fields

min_limit: usize

Configured minimum limit.

initial_limit: usize

Configured initial limit.

max_limit: usize

Configured maximum limit.

message: &'static str

Validation failure explanation.

SerializeJson

Serializing a JSON request body failed.

Fields

source: Error

Source serialization error.

SerializeQuery

Serializing query parameters failed.

Fields

source: Error

Source serialization error.

SerializeForm

Serializing a form request body failed.

Fields

source: Error

Source serialization error.

RequestBuild

Building the HTTP request object failed.

Fields

source: Error

Source request construction error.

Transport

The transport layer failed before a response was received.

Fields

kind: TransportErrorKind

High-level transport failure category.

method: Method

Request method.

uri: String

Redacted request URI.

message: String

Flattened summary of the underlying error chain.

source: Box<dyn Error + Send + Sync>

Underlying transport error.

Timeout

A request phase exceeded its timeout.

Fields

phase: TimeoutPhase

Timeout phase that elapsed.

timeout_ms: u128

Timeout duration in milliseconds.

method: Method

Request method.

uri: String

Redacted request URI.

DeadlineExceeded

The overall request deadline elapsed.

Fields

timeout_ms: u128

Deadline duration in milliseconds.

method: Method

Request method.

uri: String

Redacted request URI.

ReadBody

Reading a buffered response body failed.

Fields

source: Box<dyn Error + Send + Sync>

Underlying body read error.

WriteBody

Writing a streamed response body to a sink failed.

Fields

method: Method

Request method.

uri: String

Redacted request URI.

source: Box<dyn Error + Send + Sync>

Underlying writer error.

ResponseBodyTooLarge

The response body exceeded the configured byte limit.

Fields

limit_bytes: usize

Configured body size limit in bytes.

actual_bytes: usize

Actual body size observed in bytes.

method: Method

Request method.

uri: String

Redacted request URI.

HttpStatus

The response status failed the active status policy.

Fields

status: u16

HTTP status code.

method: Method

Request method.

uri: String

Redacted request URI.

headers: Box<HeaderMap>

Captured response headers.

body: String

Truncated response body text.

DeserializeJson

Deserializing a JSON response body failed.

Fields

source: Error

Source deserialization error.

body: String

Truncated response body text.

DecodeText

Decoding the response body as UTF-8 failed.

Fields

source: Utf8Error

Source UTF-8 decoding error.

body: String

Truncated response body text.

InvalidHeaderName

A header name was invalid.

Fields

name: String

Header name that failed validation.

source: InvalidHeaderName

Source header parsing error.

InvalidHeaderValue

A header value was invalid.

Fields

name: String

Header name associated with the invalid value.

source: InvalidHeaderValue

Source header parsing error.

DecodeContentEncoding

Decoding a compressed response body failed.

Fields

encoding: String

Content encoding that failed to decode.

method: Method

Request method.

uri: String

Redacted request URI.

message: String

Human-readable decode failure message.

ConcurrencyLimitClosed

A request could not enter a closed concurrency limiter.

TlsBackendUnavailable

The selected TLS backend is not compiled into this build.

Fields

backend: &'static str

Name of the unavailable backend.

TlsBackendInit

Initializing the selected TLS backend failed.

Fields

backend: &'static str

Name of the backend that failed to initialize.

message: String

Human-readable initialization failure message.

TlsConfig

TLS configuration was not supported by the selected backend.

Fields

backend: &'static str

Name of the backend that rejected the configuration.

message: String

Human-readable validation failure message.

RetryBudgetExhausted

Retry budget enforcement rejected another retry attempt.

Fields

method: Method

Request method.

uri: String

Redacted request URI.

CircuitOpen

The circuit breaker rejected the request.

Fields

method: Method

Request method.

uri: String

Redacted request URI.

retry_after_ms: u128

Retry-after delay in milliseconds.

MissingRedirectLocation

A redirect response did not include a Location header.

Fields

status: u16

Redirect status code.

method: Method

Request method.

uri: String

Redacted request URI.

InvalidRedirectLocation

A redirect target could not be parsed.

Fields

location: String

Unparseable redirect target.

method: Method

Request method.

uri: String

Redacted request URI.

RedirectLimitExceeded

Redirect handling exceeded the configured redirect limit.

Fields

max_redirects: usize

Maximum redirects permitted.

method: Method

Request method.

uri: String

Redacted request URI.

RedirectBodyNotReplayable

Redirect handling required replaying a non-replayable request body.

Fields

method: Method

Request method.

uri: String

Redacted request URI.

Implementations

impl Error

pub const fn code(&self) -> ErrorCode

Returns the stable machine-readable error code for this error.

pub const fn status_code(&self) -> Option<u16>

Returns the HTTP status code for Error::HttpStatus.

pub const fn response_headers(&self) -> Option<&HeaderMap>

Returns the captured response headers for Error::HttpStatus.

pub fn retry_after(&self, now: SystemTime) -> Option<Duration>

Parses a Retry-After hint from the captured response headers.

pub fn request_id(&self) -> Option<&str>

Returns a request identifier from captured response headers when available.

pub fn request_method(&self) -> Option<&Method>

Returns the originating request method when the error carries one.

pub fn request_uri_redacted(&self) -> Option<&str>

Returns the redacted request URI associated with this error.

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

Returns an owned copy of the redacted request URI.

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

Returns just the request path component when a request URI is available.

Trait Implementations

impl Debug for Error

fn fmt(&self, formatter: &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.