Skip to main content

Error

Enum Error 

Source
pub enum Error {
Show 25 variants MissingApiKey(String), Http(Error), Cancelled, Timeout(String), Json(Error), StreamProtocol(String), ProviderStream(String), ResponseLimit { resource: &'static str, limit: usize, }, Api { provider: &'static str, status: u16, body: String, retry_after: Option<Duration>, retry_source: Option<RetrySource>, request_id: Option<String>, }, MissingModel(&'static str), InvalidRequest(String), Unsupported(String), ToolNotFound(String), ToolFailed { tool: String, message: String, }, MaxSteps(usize), Normalize(String), InvalidRetryPolicy(String), HeaderValue(InvalidHeaderValue), HeaderName(InvalidHeaderName), ProtectedHeader(String), NonAsciiHeaderValue { name: String, }, ReservedExtraBodyField { protocol: &'static str, field: String, }, ReservedExtraQuery { protocol: &'static str, parameter: String, }, InvalidEndpoint(String), InvalidProfile(String),
}
Expand description

The error type returned by this crate’s public API.

Its Display output is safe to log: the Api variant never embeds the raw provider response body, and the Debug output redacts it. Use Error::kind for stable classification and Error::raw_body when you explicitly need the provider body.

Variants§

§

MissingApiKey(String)

No API key was configured for the provider.

§

Http(Error)

The HTTP request to the provider failed at the transport level.

§

Cancelled

The request was cancelled before it completed.

§

Timeout(String)

The request exceeded its configured timeout.

§

Json(Error)

A response body was not valid JSON.

§

StreamProtocol(String)

The provider’s stream emitted a malformed or unexpected event.

§

ProviderStream(String)

The provider reported an error inside a stream.

§

ResponseLimit

A decoded response exceeded its configured resource budget.

Fields

§resource: &'static str

Name of the bounded resource, without provider content.

§limit: usize

Configured maximum.

§

Api

Fields

§provider: &'static str

The provider identifier, such as openai.

§status: u16

HTTP status code returned by the provider.

§body: String

Raw response body. Excluded from log-safe output; see Error::raw_body.

§retry_after: Option<Duration>

Parsed server-directed retry delay, when present.

§retry_source: Option<RetrySource>

Which header produced retry_after.

§request_id: Option<String>

Provider request id copied from response metadata, when present.

§

MissingModel(&'static str)

A provider was configured without a model.

§

InvalidRequest(String)

The request could not be built as specified.

§

Unsupported(String)

The selected provider does not support the requested operation.

§

ToolNotFound(String)

The model requested a tool that was never registered.

§

ToolFailed

A registered tool returned an error while executing.

Fields

§tool: String

Name of the tool that failed.

§message: String

Error message reported by the tool.

§

MaxSteps(usize)

The agent loop exceeded its configured step budget.

§

Normalize(String)

A request could not be normalized for the target protocol.

§

InvalidRetryPolicy(String)

A retry policy configuration was invalid.

§

HeaderValue(InvalidHeaderValue)

An HTTP header value was invalid.

§

HeaderName(InvalidHeaderName)

An HTTP header name was invalid.

§

ProtectedHeader(String)

An attempt was made to override a header the SDK manages itself.

§

NonAsciiHeaderValue

A header value contained non-ASCII characters.

Fields

§name: String

Name of the offending header.

§

ReservedExtraBodyField

An extra body field collided with a canonical SDK field.

Fields

§protocol: &'static str

The provider protocol that rejected the field.

§field: String

The reserved field name.

§

ReservedExtraQuery

An extra query parameter collided with an endpoint-reserved name.

Fields

§protocol: &'static str

The provider protocol that rejected the parameter.

§parameter: String

The reserved parameter name.

§

InvalidEndpoint(String)

A base URL or endpoint could not be parsed.

§

InvalidProfile(String)

A provider profile configuration was invalid.

Implementations§

Source§

impl Error

Source

pub fn kind(&self) -> ErrorKind

Classify this error into a stable, provider-neutral ErrorKind.

Source

pub fn status(&self) -> Option<u16>

Provider HTTP status, when this error came from an API response.

Source

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

Provider name, when this error came from an API response.

Source

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

Provider request id, when the response exposed one.

Source

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

Return the raw provider error body.

This is intentionally opt-in because provider errors can echo request content, account data, or other sensitive values. Prefer Self::body_bytes, Self::status, and Self::request_id for logs and metrics.

Source

pub fn body_bytes(&self) -> Option<usize>

Decoded provider error-body size in bytes, without exposing the body.

Source

pub fn provider_error(&self) -> Option<ProviderErrorInfo>

Parse a safe, provider-neutral summary of a structured API error.

Provider messages are never included. Codes, types, and status tokens are only returned when they are short, ASCII machine tokens.

Source

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

Return the parsed Retry-After duration, if this error came from an HTTP response that supplied one.

Source

pub fn retry_source(&self) -> Option<RetrySource>

Return which response header produced the retry delay.

Source

pub fn is_retryable(&self) -> bool

Whether this error is normally safe to retry.

This is a conservative classification. Callers should still avoid retrying non-idempotent operations unless they have an idempotency key.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<Error> for Error

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for Error

Source§

fn from(error: Error) -> Self

Converts to this type from the input type.
Source§

impl From<InvalidHeaderName> for Error

Source§

fn from(source: InvalidHeaderName) -> Self

Converts to this type from the input type.
Source§

impl From<InvalidHeaderValue> for Error

Source§

fn from(source: InvalidHeaderValue) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more