Enum Error 

#[non_exhaustive]
pub enum Error {
    CliNotFound,
    CliVersionTooOld {
        found: String,
        required: String,
    },
    CliConnection(String),
    Process(String),
    ProcessExit {
        code: i32,
        stderr: String,
    },
    JsonDecode(Error),
    MessageParse {
        reason: String,
    },
    ControlTimeout(Duration),
    ControlProtocol(String),
    TransportClosed,
    NotConnected,
    AlreadyConnected,
    Io(Error),
    Mcp {
        code: i64,
        message: String,
    },
    Hook(String),
}

All errors that can occur in the Claude Agent SDK.

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

CliVersionTooOld

Fields

found: String

required: String

CliConnection(String)

Process(String)

ProcessExit

Fields

code: i32

stderr: String

JsonDecode(Error)

MessageParse

Fields

reason: String

ControlTimeout(Duration)

ControlProtocol(String)

TransportClosed

NotConnected

AlreadyConnected

Io(Error)

Mcp

Fields

code: i64

message: String

Hook(String)

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.