Enum Error 

#[non_exhaustive]
pub enum Error {
    CliNotFound,
    VersionMismatch {
        found: String,
        required: String,
    },
    SpawnFailed(Error),
    ProcessExited {
        code: Option<i32>,
        stderr: String,
    },
    ParseError {
        message: String,
        line: String,
    },
    Io(Error),
    Json(Error),
    NotConnected,
    Transport(String),
    Config(String),
    ControlProtocol(String),
    ImageValidation(String),
    Timeout(String),
    Cancelled,
}

All errors that can be produced by the claude-code SDK.

Variants are non-exhaustive in the sense that future SDK versions may add new variants — callers should include a wildcard arm when matching.

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.

CliNotFound

The Claude Code CLI binary was not found on PATH.

Install it with: npm install -g @anthropic-ai/claude-code

VersionMismatch

The discovered CLI version is below the minimum required by this SDK.

Fields

found: String

The version that was discovered on the system.

required: String

The minimum version required by this SDK.

SpawnFailed(Error)

The OS failed to spawn the Claude child process.

ProcessExited

The Claude process exited with a non-zero (or missing) status code.

code is None when the process was killed by a signal.

Fields

code: Option<i32>

The exit code, or None if the process was killed by a signal.

stderr: String

Captured stderr output from the process.

ParseError

A line from the Claude process could not be parsed as valid JSON.

Fields

message: String

Human-readable description of the parse failure.

line: String

The raw line that could not be parsed (truncated to 200 chars).

Io(Error)

Transparent wrapper around std::io::Error.

Json(Error)

Transparent wrapper around serde_json::Error.

NotConnected

A method that requires an active connection was called before connect().

Transport(String)

An error in the underlying stdio/socket transport layer.

Config(String)

A configuration value is absent or out of range.

ControlProtocol(String)

The structured control protocol exchanged with the CLI returned an unexpected message or sequence.

ImageValidation(String)

An image payload failed validation (unsupported MIME type or exceeds the 15 MiB base64 size limit).

Timeout(String)

An async operation exceeded its deadline.

Cancelled

The operation was cancelled via a CancellationToken.

Implementations

impl Error

pub fn is_process_exit(&self) -> bool

Returns true if this error indicates the process exited cleanly but with a failure code (i.e., not a transport or protocol fault).

pub fn is_retriable(&self) -> bool

Returns true if this error is transient and the caller might reasonably retry (e.g., I/O errors, timeouts).

pub fn is_cancelled(&self) -> bool

Returns true if this error indicates the operation was cancelled via a CancellationToken.

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.