Struct ProviderError 

pub struct ProviderError { /* private fields */ }

A normalized provider failure.

Built with the constructors below and enriched with with_model once the caller knows which candidate produced it. Display and Debug are safe to log: the endpoint’s own sentence is carried but rendered by neither, and is read deliberately through detail. See ProviderDetail.

Implementations

impl ProviderError

pub const fn new(kind: ProviderErrorKind) -> Self

Builds an error from a kind.

pub const fn timeout() -> Self

The call did not complete in time.

pub const fn rate_limited(retry_after: Option<Duration>) -> Self

The provider rate-limited the request.

pub const fn authentication() -> Self

The credentials were rejected.

pub const fn authorization() -> Self

The credentials are not entitled to this model.

pub const fn credential_expired() -> Self

A credential that was valid has expired and must be refreshed.

Use this, not authentication, whenever the provider distinguishes the two — a rejected key and an expired token call for opposite reactions from whatever holds the credential.

pub fn quota_exhausted(scope: Option<&str>) -> Self

The account’s quota or credit balance is exhausted.

scope names the quota when the provider names one. Use this, not rate_limited, even when the provider reports it with HTTP 429.

pub fn invalid_request(code: impl AsRef<str>) -> Self

The provider rejected our request shape.

pub const fn context_overflow( needed_tokens: Option<u64>, limit_tokens: Option<u64>, ) -> Self

The prompt did not fit the context window.

pub const fn model_not_found() -> Self

The configured model does not exist at this provider.

pub const fn refusal() -> Self

The model declined to answer.

pub const fn content_filter() -> Self

The provider’s safety filter blocked the exchange.

pub fn malformed(code: impl AsRef<str>) -> Self

The response could not be normalized. code says which step failed.

pub fn transport(code: impl AsRef<str>) -> Self

The network call did not complete.

pub const fn server(status: Option<u16>) -> Self

The provider failed on its side.

pub const fn cancelled() -> Self

The caller cancelled the call.

pub fn capability_mismatch(mismatch: CapabilityMismatch) -> Self

The provider-model pair does not satisfy the stage’s requirements.

pub fn unsupported(feature: impl AsRef<str>) -> Self

The adapter cannot serve a requested feature.

pub fn other(code: impl AsRef<str>) -> Self

An unclassified failure. Treated as RetryClass::Fatal.

pub fn with_detail(self, detail: impl AsRef<str>) -> Self

Attaches the endpoint’s own sentence, sanitized.

Pass it through the adapter’s Redactor first, the way a code is. Nothing is attached when nothing survives sanitizing.

pub fn detail(&self) -> Option<&ProviderDetail>

The endpoint’s own sentence, when the adapter had one.

Deliberately not in Display: see ProviderDetail.

pub fn with_code(self, code: impl AsRef<str>) -> Self

Attaches a sanitized adapter code.

pub fn with_provider(self, provider: impl Into<ProviderKey>) -> Self

Attaches the provider key.

pub fn with_model(self, model: &ModelRef) -> Self

Attaches provider and model keys at once.

pub fn kind(&self) -> &ProviderErrorKind

The failure family.

pub fn provider(&self) -> Option<&ProviderKey>

The provider key, when known.

pub fn model(&self) -> Option<&ModelKey>

The model key, when known.

pub fn code(&self) -> Option<&ErrorCode>

The adapter’s sanitized code, when it supplied one.

pub const fn retry_class(&self) -> RetryClass

How the caller may proceed.

pub const fn retry_after(&self) -> Option<Duration>

The delay the provider asked for, when it supplied one.

pub const fn is_retryable(&self) -> bool

Returns true when the same provider may be called again.

pub fn to_core_failure(&self) -> ProviderFailure

Converts into the normalized failure the core error family stores.

Trait Implementations

impl Clone for ProviderError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProviderError

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

Renders everything Display does, and says only whether an endpoint sentence is attached.

Hand-written rather than derived because a derived one would print the sentence, and {:?} on an error is the most common way a body reaches a log by accident. The value is still there for a caller that asks for it.

impl Display for ProviderError

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

Renders kind, keys and code — never a body, a header or user text.

impl Eq for ProviderError

impl Error for ProviderError

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

fn from(value: CapabilityMismatch) -> Self

Converts to this type from the input type.

impl From<DialectError> for ProviderError

fn from(value: DialectError) -> Self

A schema the dialect cannot carry is an Unsupported feature, whose retry class is Fallback.

The capability declaration stays true: this provider does enforce schemas, it just cannot enforce this one. So the router may offer the turn to another profile, and must not re-roll against the same one.

impl From<ProviderError> for ProviderFailure

fn from(value: ProviderError) -> Self

Converts to this type from the input type.

impl From<StructuredOutputError> for ProviderError

fn from(value: StructuredOutputError) -> Self

A rejected structured response is a Refusal when the model declined, and Malformed otherwise — so a re-roll is the classified remedy.

impl PartialEq for ProviderError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProviderError