Skip to main content

Error

Enum Error 

Source
pub enum Error {
    Http(Error),
    Json(Error),
    Api {
        status: u16,
        message: String,
        error_type: Option<String>,
    },
    RateLimit {
        retry_after: Option<u64>,
        message: String,
    },
    InvalidRequest(String),
    Authentication(String),
    Server {
        status: u16,
        message: String,
    },
    Network(String),
    StreamParse(String),
}
Expand description

Main error type for Claude SDK operations.

This enum covers all possible error conditions when using the SDK. Use Error::is_retryable to check if an error can be retried.

§Example

use claude_sdk::Error;

fn handle_error(err: Error) {
    if err.is_retryable() {
        println!("Can retry after {:?}s", err.retry_after());
    } else {
        println!("Fatal error: {}", err);
    }
}

Variants§

§

Http(Error)

HTTP request failed.

This wraps errors from the underlying HTTP client (reqwest). May be retryable depending on the specific error.

§

Json(Error)

Failed to parse JSON response.

This typically indicates a bug or API contract change.

§

Api

API returned an error response.

Contains the HTTP status code and error message from the API. Check error_type for specific error categories like “invalid_request_error”.

Fields

§status: u16

HTTP status code

§message: String

Error message from the API

§error_type: Option<String>

Error type (e.g., “invalid_request_error”, “authentication_error”)

§

RateLimit

Rate limit exceeded (HTTP 429).

The API has rate-limited your request. Check retry_after for the recommended wait time before retrying.

Fields

§retry_after: Option<u64>

Seconds to wait before retrying (from Retry-After header)

§message: String

Error message from the API

§

InvalidRequest(String)

Invalid request.

The request was malformed or missing required fields. This is not retryable - fix the request before trying again.

§

Authentication(String)

Authentication failed.

The API key is invalid, expired, or missing required permissions. Not retryable - verify your API key configuration.

§

Server

Server error (HTTP 5xx).

The API server encountered an internal error. These are typically transient and can be retried with exponential backoff.

Fields

§status: u16

HTTP status code (500-599)

§message: String

Error message

§

Network(String)

Network error.

Connection failed, timed out, or was interrupted. Usually retryable after a brief delay.

§

StreamParse(String)

SSE stream parsing error.

Failed to parse a server-sent event during streaming. May indicate a malformed response or connection issue.

Implementations§

Source§

impl Error

Source

pub fn is_retryable(&self) -> bool

Check if this error is retryable.

Returns true for transient errors that may succeed on retry:

  • Rate limits (with backoff)
  • Server errors (5xx)
  • Network errors
§Example
use claude_sdk::Error;

fn should_retry(err: &Error) -> bool {
    err.is_retryable()
}
Source

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

Get retry-after duration in seconds if available.

Only returns a value for Error::RateLimit errors that include a Retry-After header from the API.

§Example
use claude_sdk::Error;
use std::time::Duration;

async fn wait_and_retry(err: &Error) {
    if let Some(seconds) = err.retry_after() {
        tokio::time::sleep(Duration::from_secs(seconds)).await;
    }
}

Trait Implementations§

Source§

impl Debug for Error

Source§

fn fmt(&self, f: &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(source: Error) -> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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