Enum Error 

#[non_exhaustive]
pub enum Error<E> {
    RequestConstruction(RequestError),
    Transport(TransportError),
    Timeout(TimeoutKind),
    Protocol(ProtocolError),
    Redirect(RedirectError),
    Api(ResponseValue<E>),
    UnexpectedStatus {
        status: StatusCode,
        headers: HeaderMap,
        body: Bytes,
    },
    Decode {
        status: StatusCode,
        headers: HeaderMap,
        path: String,
        body: Bytes,
        truncated: bool,
    },
    InterruptedBody(TransportError),
}

The closed error taxonomy shared by every spargen-generated client. E is the operation’s typed error body (an enum when several error statuses are documented).

Nine variants are constructed; taxonomy class #10 (cancellation) is a documented drop-safety guarantee, not a variant (see the crate docs). Every variant implements std::error::Error with full source chains, and Debug never leaks secrets.

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.

RequestConstruction(RequestError)

#1 — invalid base URL, or parameter/body serialization failure (near-impossible by construction).

Transport(TransportError)

#2 — DNS failure, connection refused/reset, TLS handshake or certificate error.

Timeout(TimeoutKind)

#3 — connect vs total-request timeout (as configured on the injected client).

Protocol(ProtocolError)

#4 — malformed HTTP or decompression failure.

Redirect(RedirectError)

#5 — redirect-policy exhaustion (per the injected client’s policy).

Api(ResponseValue<E>)

#6 — a documented non-success status parsed into the operation’s typed error body.

UnexpectedStatus

#7 — an undocumented status; the raw body is preserved for forensics.

Fields

status: StatusCode

The response status.

headers: HeaderMap

The response headers.

body: Bytes

The raw response body.

Decode

#8 — the response body failed to deserialize; retains the response status and headers (so the status and a request-ID header survive a body the client cannot read), the serde error path, and the (capped) raw body. For a streamed item they are those of the response that carried the malformed frame.

Fields

status: StatusCode

The response status.

headers: HeaderMap

The response headers.

path: String

The serde deserialization error path.

body: Bytes

The retained raw body (up to the configured cap).

truncated: bool

Whether the retained body was truncated at the cap.

InterruptedBody(TransportError)

#9 — the connection dropped mid-stream on a streamed response.

Implementations

impl<E> Error<E>

pub fn request_construction(source: impl Error + Send + Sync + 'static) -> Self

Build a request-construction error from any owned error value.

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

Build a request-construction error from a static message.

pub fn from_reqwest(error: Error) -> Self

Classify a reqwest error into the closest runtime taxonomy class.

pub fn is_transient(&self) -> bool

Whether the failure is worth retrying: transport failures, timeouts, 429, and 5xx Lets callers wrap any retry policy around the client without spargen shipping one.

impl Error<Infallible>

pub fn widen<E>(self) -> Error<E>

Widen a never-typed failure into any operation’s error type. Dispatch routines that cannot produce a typed API error return Error<Infallible>; generated shims widen at the call site via .map_err(Error::widen).

Trait Implementations

impl<E: Debug> Debug for Error<E>

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

Formats the value using the given formatter.

impl<E: Display> Display for Error<E>

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

Formats the value using the given formatter.

impl<E: Error + 'static> Error for Error<E>

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.