Enum PipelineError 

#[non_exhaustive]
pub enum PipelineError {
    BadRequest {
        context: String,
        source: Option<ErrorSource>,
    },
    Unauthorized(String),
    Blocked {
        context: String,
        source: Option<ErrorSource>,
    },
    Upstream {
        context: String,
        source: Option<ErrorSource>,
    },
    UpstreamTimeout {
        context: String,
        source: Option<ErrorSource>,
    },
    Abort(String),
    Unavailable {
        context: String,
        source: Option<ErrorSource>,
    },
}

Hot-path failures, each carrying an HTTP status mapping.

Variants that wrap an underlying failure carry it as a typed #[source] instead of a pre-rendered String; context keeps the exact text the old String payloads rendered, so Display output (embedded verbatim in the OpenAI-shaped HTTP error bodies) is unchanged. Unauthorized and Abort stay plain strings: their messages are deliberately classified policy verdicts (the raw identity error is logged separately and must not travel with the client-facing value).

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.

BadRequest

A request header was malformed or inconsistent.

Fields

context: String

Human-readable description.

source: Option<ErrorSource>

Underlying typed error, when one exists.

Unauthorized(String)

Identity was missing or invalid.

Blocked

A stateful quota or loop breaker blocked execution.

Fields

context: String

Human-readable description.

source: Option<ErrorSource>

Underlying typed error, when one exists.

Upstream

The upstream provider request failed.

Fields

context: String

Human-readable description.

source: Option<ErrorSource>

Underlying typed error, when one exists.

UpstreamTimeout

The upstream provider accepted the connection but did not finish responding within upstream_read_timeout_s. Distinct from Self::Upstream so the response layer can map to 504 Gateway Timeout (RFC 7231 §6.6.5) rather than 502 Bad Gateway, letting operator dashboards distinguish “provider slow” (504 — check provider health) from “provider unreachable” (502 — check DNS / network / config). SDK retry behaviour is unchanged (both retryable).

Fields

context: String

Human-readable description.

source: Option<ErrorSource>

Underlying typed error, when one exists.

Abort(String)

The breaker requested immediate connection closure.

Unavailable

Required audit capture infrastructure is unavailable.

Fields

context: String

Human-readable description.

source: Option<ErrorSource>

Underlying typed error, when one exists.

Implementations

impl PipelineError

pub fn bad_request(context: impl Into<String>) -> Self

Semantic bad-request refusal with no underlying typed error.

pub fn bad_request_source<E>(error: E) -> Self

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

Bad request caused by a typed error. The error text is kept in context so Display matches the old stringified payload, while the value itself stays reachable via Error::source().

pub fn blocked(context: impl Into<String>) -> Self

Semantic policy block with no underlying typed error.

pub fn blocked_source<E>(error: E) -> Self

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

Block caused by a typed error (see Self::bad_request_source).

pub fn upstream(context: impl Into<String>) -> Self

Semantic upstream failure with no underlying typed error.

pub fn upstream_source<E>(error: E) -> Self

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

Upstream failure caused by a typed error (see Self::bad_request_source).

pub fn upstream_timeout(context: impl Into<String>) -> Self

Semantic upstream-timeout failure with no underlying typed error. Response layer maps this to 504 Gateway Timeout (see Self::UpstreamTimeout docs).

pub fn unavailable(context: impl Into<String>) -> Self

Semantic unavailability with no underlying typed error.

pub fn unavailable_source<E>(error: E) -> Self

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

Unavailability caused by a typed error (see Self::bad_request_source).

pub fn status(&self) -> StatusCode

HTTP status code corresponding to this failure.

• Blocked / Abort are permanent policy verdicts for the current session: 403 / 409 stop mainstream SDK auto-retry loops that would otherwise interpret 429 as transient rate limiting and burn budget re-hitting the same breaker.
• Unavailable is transient: 503 is paired with Retry-After at the response layer so intermediaries and clients back off in bounded fashion (RFC 7231 §7.1.3).
• Unauthorized is paired with WWW-Authenticate at the response layer (RFC 7235 §3.1).

Trait Implementations

impl Debug for PipelineError

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

Formats the value using the given formatter.

impl Display for PipelineError

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

Formats the value using the given formatter.

impl Error for PipelineError

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.