Enum Error 

#[non_exhaustive]
pub enum Error {
    #[non_exhaustive]
    Api {
        status: StatusCode,
        request_id: Option<String>,
        kind: ApiErrorKind,
        message: String,
        retry_after: Option<Duration>,
    },
    Network(Error),
    Decode(Error),
    Stream(StreamError),
    InvalidConfig(String),
    Io(Error),
    MaxIterationsExceeded {
        max: u32,
    },
    CostBudgetExceeded {
        budget_usd: f64,
        spent_usd: f64,
    },
    Cancelled,
    ToolApprovalStopped {
        tool_name: String,
        reason: String,
    },
    Signing(Box<dyn Error + Send + Sync + 'static>),
}

Errors returned by this crate.

Variants tied to optional features (async/sync for Error::Network, streaming for Error::Stream) are conditionally compiled out when those features are disabled. Use Error::is_retryable to decide whether to retry; the crate::retry layer uses the same logic.

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.

#[non_exhaustive]

Api

The Anthropic API returned an error response.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

status: StatusCode

HTTP status code returned by the API.

request_id: Option<String>

request-id header from the response, if present. Critical for support tickets.

kind: ApiErrorKind

Decoded error category from the response body.

message: String

Human-readable error message from the response body.

retry_after: Option<Duration>

Retry-After value parsed from the response, if present.

Network(Error)

Available on crate features async or sync only.

Underlying HTTP transport failed (timeout, connection refused, DNS, etc.).

Decode(Error)

Response body could not be parsed as JSON.

Stream(StreamError)

Available on crate feature streaming only.

Streaming error (parse, connection lost, server-emitted error event).

InvalidConfig(String)

The crate::ClientBuilder was misconfigured.

Io(Error)

Local I/O failed (e.g. reading a file to upload).

MaxIterationsExceeded

The agent loop runner reached its iteration limit without the model producing a non-tool_use stop reason.

Fields

max: u32

Configured iteration cap.

CostBudgetExceeded

The agent loop’s configured cost budget was exceeded after a turn. spent_usd reflects the cumulative cost recorded on the conversation at the moment the budget check fired.

Fields

budget_usd: f64

Configured ceiling.

spent_usd: f64

Cumulative spend at the time of the check.

Cancelled

A cancellation token signaled abort between iterations.

ToolApprovalStopped

A ToolApprover returned ApprovalDecision::Stop, ending the loop before the named tool could run.

Fields

tool_name: String

Name of the tool whose approval check returned Stop.

reason: String

Reason supplied by the approver.

Signing(Box<dyn Error + Send + Sync + 'static>)

Available on crate feature async only.

A RequestSigner returned an error while signing an outbound request.

Implementations

impl Error

pub fn is_retryable(&self) -> bool

Returns true if the error represents a transient failure worth retrying.

Single source of truth used by both crate::retry::RetryPolicy and callers handling retries themselves.

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

request-id header from the API response, if this is an Error::Api.

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

Retry-After value from the API response, if any.

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

HTTP status code, if this is an Error::Api.

Trait Implementations

impl Debug for Error

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

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<StreamError> for Error

fn from(source: StreamError) -> Self

Converts to this type from the input type.