Enum SdkError 

pub enum SdkError {
    CliNotFound {
        searched_paths: String,
    },
    ConnectionError(String),
    ProcessError(Error),
    MessageParseError {
        error: String,
        raw: String,
    },
    JsonError(Error),
    CliJsonDecodeError {
        line: String,
        original_error: Error,
    },
    TransportError(String),
    Timeout {
        seconds: u64,
    },
    SessionNotFound(String),
    ConfigError(String),
    ControlRequestError(String),
    UnexpectedResponse {
        expected: String,
        actual: String,
    },
    CliError {
        message: String,
        code: Option<String>,
    },
    ChannelSendError,
    ChannelClosed,
    InvalidState {
        message: String,
    },
    ProcessExited {
        code: Option<i32>,
    },
    UnexpectedStreamEnd,
    NotSupported {
        feature: String,
    },
}

Main error type for the Claude Code SDK

Variants

CliNotFound

Claude CLI executable was not found

Fields

searched_paths: String

Paths that were searched for the CLI

ConnectionError(String)

Failed to connect to Claude CLI

ProcessError(Error)

Process-related errors

MessageParseError

Failed to parse a message

Fields

error: String

Parse error description

raw: String

Raw message that failed to parse

JsonError(Error)

JSON serialization/deserialization errors

CliJsonDecodeError

CLI JSON decode error

Fields

line: String

Line that failed to decode

original_error: Error

Original error

TransportError(String)

Transport layer errors

Timeout

Timeout waiting for response

Fields

seconds: u64

Number of seconds waited before timeout

SessionNotFound(String)

Session not found

ConfigError(String)

Invalid configuration

ControlRequestError(String)

Control request failed

UnexpectedResponse

Unexpected response type

Fields

expected: String

Expected response type

actual: String

Actual response type received

CliError

CLI returned an error

Fields

message: String

Error message from CLI

code: Option<String>

Error code if available

ChannelSendError

Channel send error

ChannelClosed

Channel receive error

InvalidState

Invalid state transition

Fields

message: String

Description of the invalid state

ProcessExited

Process exited unexpectedly

Fields

code: Option<i32>

Exit code if available

UnexpectedStreamEnd

Stream ended unexpectedly

NotSupported

Feature not supported

Fields

feature: String

Description of unsupported feature

Implementations

impl SdkError

pub fn parse_error(error: impl Into<String>, raw: impl Into<String>) -> Self

Create a new MessageParseError

pub fn timeout(seconds: u64) -> Self

Create a new Timeout error

pub fn unexpected_response( expected: impl Into<String>, actual: impl Into<String>, ) -> Self

Create a new UnexpectedResponse error

pub fn cli_error(message: impl Into<String>, code: Option<String>) -> Self

Create a new CliError

pub fn invalid_state(message: impl Into<String>) -> Self

Create a new InvalidState error

pub fn is_recoverable(&self) -> bool

Check if the error is recoverable

pub fn is_config_error(&self) -> bool

Check if the error is a configuration issue

Trait Implementations

impl Debug for SdkError

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

Formats the value using the given formatter.

impl Display for SdkError

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

Formats the value using the given formatter.

impl Error for SdkError

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 SdkError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RecvError> for SdkError

fn from(_: RecvError) -> Self

Converts to this type from the input type.

impl<T> From<SendError<T>> for SdkError

fn from(_: SendError<T>) -> Self

Converts to this type from the input type.