Enum ClaudeError 

pub enum ClaudeError {
    Connection(ConnectionError),
    Process(ProcessError),
    JsonDecode(JsonDecodeError),
    MessageParse(MessageParseError),
    Transport(String),
    ControlProtocol(String),
    InvalidConfig(String),
    CliNotFound(CliNotFoundError),
    ImageValidation(ImageValidationError),
    Io(Error),
    Other(Error),
    NotFound(String),
    InvalidInput(String),
    InternalError(String),
}

Main error type for the Claude Agent SDK

Variants

Connection(ConnectionError)

CLI connection error

Process(ProcessError)

Process error

JsonDecode(JsonDecodeError)

JSON decode error

MessageParse(MessageParseError)

Message parse error

Transport(String)

Transport error

ControlProtocol(String)

Control protocol error

InvalidConfig(String)

Invalid configuration

CliNotFound(CliNotFoundError)

CLI not found error

ImageValidation(ImageValidationError)

Image validation error

Io(Error)

IO error

Other(Error)

Other errors

NotFound(String)

Not found error

InvalidInput(String)

Invalid input error

InternalError(String)

Internal error

Implementations

impl ClaudeError

pub fn category(&self) -> ErrorCategory

Returns the error category for this error.

Categories group related errors together for:

• Structured logging and filtering
• Metrics aggregation
• Retry logic decisions

pub fn error_code(&self) -> &'static str

Returns a machine-readable error code for this error.

Error codes are stable identifiers that can be used for:

• Programmatic error handling
• API response codes
• Documentation references

Format: E{category_prefix}{number} (e.g., ENET001, EPROC001)

pub fn is_retryable(&self) -> bool

Returns true if this error may be retried.

Retryable errors are typically transient failures that may succeed on a subsequent attempt:

• Network errors (connection refused, timeout)
• Process errors (CLI crashed, can restart)
• External service errors (rate limits, temporary unavailable)

pub fn http_status(&self) -> HttpStatus

Returns the recommended HTTP status code for this error.

Useful for converting SDK errors to HTTP API responses.

pub fn to_error_context(&self) -> ErrorContext

Returns a detailed error context for logging and debugging.

Includes:

• Error code
• Category
• Whether it’s retryable
• Human-readable message

Trait Implementations

impl Debug for ClaudeError

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

Formats the value using the given formatter.

impl Display for ClaudeError

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

Formats the value using the given formatter.

impl Error for ClaudeError

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<CliNotFoundError> for ClaudeError

fn from(source: CliNotFoundError) -> Self

Converts to this type from the input type.

impl From<ConnectionError> for ClaudeError

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.

impl From<Error> for ClaudeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ClaudeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ImageValidationError> for ClaudeError

fn from(source: ImageValidationError) -> Self

Converts to this type from the input type.

impl From<JsonDecodeError> for ClaudeError

fn from(source: JsonDecodeError) -> Self

Converts to this type from the input type.

impl From<MessageParseError> for ClaudeError

fn from(source: MessageParseError) -> Self

Converts to this type from the input type.

impl From<ProcessError> for ClaudeError

fn from(source: ProcessError) -> Self

Converts to this type from the input type.