Enum Error

pub enum Error {
    BinaryNotFound,
    SessionNotFound(String),
    PermissionDenied(String),
    McpError(String),
    ConfigError(String),
    InvalidInput(String),
    Timeout(u64),
    SerializationError(Error),
    Io(Error),
    ProcessError(String),
    StreamClosed,
    NotAuthenticated,
    RateLimitExceeded,
    Utf8Error(FromUtf8Error),
}

Error types for Claude AI SDK operations

This enum covers all possible error conditions that can occur when using the Claude AI SDK, from configuration issues to runtime execution problems. Each error has an associated error code for easy reference.

Examples

use claude_sdk_rs_core::{Error, Result};

fn handle_error(result: Result<String>) {
    match result {
        Ok(response) => println!("Success: {}", response),
        Err(Error::BinaryNotFound) => {
            eprintln!("Error C001: Please install the Claude Code CLI first");
        }
        Err(Error::Timeout(seconds)) => {
            eprintln!("Error C007: Request timed out after {} seconds", seconds);
        }
        Err(e) => eprintln!("Error {}: {}", e.code(), e),
    }
}

Variants

BinaryNotFound

Claude Code CLI binary not found in PATH [C001]

This error occurs when the Claude Code CLI tool is not installed or not available in the system PATH. Install the CLI first.

SessionNotFound(String)

Session with the given ID was not found [C002]

Occurs when trying to access a session that doesn’t exist or has been deleted.

PermissionDenied(String)

Permission denied for the specified tool [C003]

This error occurs when trying to use a tool that’s restricted by the current configuration’s allowed_tools setting.

McpError(String)

Error from an MCP (Model Context Protocol) server [C004]

Indicates a problem with an external MCP server that Claude was trying to communicate with.

ConfigError(String)

Invalid configuration provided [C005]

Occurs when the provided configuration has invalid or conflicting settings that prevent proper operation.

InvalidInput(String)

Invalid input provided to a function [C006]

Indicates that the input parameters don’t meet the expected format or constraints.

Timeout(u64)

Operation timed out [C007]

The operation took longer than the configured timeout period. Consider increasing the timeout for complex queries.

SerializationError(Error)

JSON serialization or deserialization error [C008]

Occurs when parsing JSON responses from Claude CLI or when serializing configuration to JSON format.

Io(Error)

Input/output operation failed [C009]

Covers file system operations, network operations, and other I/O related failures.

ProcessError(String)

Process execution error [C010]

Occurs when the Claude CLI process fails to execute properly or returns an unexpected exit code.

StreamClosed

Stream was closed unexpectedly [C011]

Happens during streaming operations when the connection to Claude CLI is interrupted.

NotAuthenticated

Claude CLI is not authenticated [C012]

The Claude CLI tool needs to be authenticated before use. Run claude auth to authenticate.

RateLimitExceeded

Rate limit exceeded [C013]

Too many requests have been made in a short period. Wait before retrying.

Utf8Error(FromUtf8Error)

UTF-8 conversion error [C014]

Occurs when trying to convert bytes to UTF-8 string but the data contains invalid UTF-8 sequences.

Implementations

impl Error

pub fn code(&self) -> ErrorCode

Get the error code for this error

Error codes are useful for programmatic error handling and for looking up specific troubleshooting steps.

Example

use claude_sdk_rs_core::Error;

let error = Error::BinaryNotFound;
assert_eq!(error.code().to_string(), "C001");

pub fn is_recoverable(&self) -> bool

Check if this error is recoverable

Some errors can be recovered from by retrying or changing configuration, while others indicate permanent failures.

Example

use claude_sdk_rs_core::Error;

let error = Error::Timeout(30);
if error.is_recoverable() {
    // Can retry with longer timeout
}

Trait Implementations

impl Clone for Error

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 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 InteractiveError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<InteractiveError> for Error

fn from(err: InteractiveError) -> Self

Converts to this type from the input type.