Enum ClaudeError 

pub enum ClaudeError {
    CliNotFound(String),
    Connection(String),
    Process {
        message: String,
        exit_code: i32,
        stderr: Option<String>,
    },
    JsonDecode(Error),
    MessageParse {
        message: String,
        data: Option<Value>,
    },
    Transport(String),
    ControlProtocol(String),
    Hook(String),
    Mcp(String),
    Io(Error),
    Timeout(String),
    InvalidConfig(String),
    SessionNotFound(String),
    SessionComplete(String),
    MaxSessionsReached(usize),
    InvalidAgentConfiguration(String),
    PromptTemplateError {
        template: String,
        message: String,
    },
}

Main error type for the Claude Agent SDK

Variants

CliNotFound(String)

Claude Code CLI not found or not installed

Connection(String)

Connection error when communicating with Claude Code

Process

Process execution error with exit code and stderr

Fields

message: String

Error message

exit_code: i32

Process exit code

stderr: Option<String>

Standard error output

JsonDecode(Error)

JSON decode error when parsing CLI output

MessageParse

Message parse error with optional raw data

Fields

message: String

Error message

data: Option<Value>

Raw message data that failed to parse

Transport(String)

Transport layer error

ControlProtocol(String)

Control protocol error

Hook(String)

Hook execution error

Mcp(String)

MCP (Model Context Protocol) error

Io(Error)

I/O error

Timeout(String)

Timeout error

InvalidConfig(String)

Invalid configuration

SessionNotFound(String)

Agent session not found

SessionComplete(String)

Agent session already complete (cannot send more messages)

MaxSessionsReached(usize)

Maximum active sessions limit reached

InvalidAgentConfiguration(String)

Invalid agent session configuration

PromptTemplateError

Failed to render prompt template

Fields

template: String

Template name

message: String

Error message

Implementations

impl ClaudeError

pub fn cli_not_found() -> Self

Create a CLI not found error

pub fn connection(msg: impl Into<String>) -> Self

Create a connection error

pub fn process( msg: impl Into<String>, exit_code: i32, stderr: Option<String>, ) -> Self

Create a process error

pub fn message_parse(msg: impl Into<String>, data: Option<Value>) -> Self

Create a message parse error

pub fn transport(msg: impl Into<String>) -> Self

Create a transport error

pub fn control_protocol(msg: impl Into<String>) -> Self

Create a control protocol error

pub fn protocol_error(msg: impl Into<String>) -> Self

Alias for control_protocol - used by protocol handler

pub fn json_encode(msg: impl Into<String>) -> Self

Create a JSON encode error

pub fn json_decode(msg: impl Into<String>) -> Self

Create a JSON decode error from string

pub fn hook(msg: impl Into<String>) -> Self

Create a hook error

pub fn mcp(msg: impl Into<String>) -> Self

Create an MCP error

pub fn timeout(msg: impl Into<String>) -> Self

Create a timeout error

pub fn invalid_config(msg: impl Into<String>) -> Self

Create an invalid configuration error

pub fn session_not_found(session_id: impl Into<String>) -> Self

Create a session not found error

pub fn session_complete(session_id: impl Into<String>) -> Self

Create a session complete error

pub fn max_sessions_reached(max: usize) -> Self

Create a max sessions error

pub fn invalid_agent_config(msg: impl Into<String>) -> Self

Create an invalid agent configuration error

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

fn from(err: ClaudeError) -> 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.