Enum Error 

#[non_exhaustive]
pub enum Error {
    Protocol(ProtocolError),
    Rpc {
        code: i32,
        message: String,
    },
    Session(SessionError),
    Io(Error),
    Json(Error),
    BinaryNotFound {
        name: &'static str,
        hint: &'static str,
    },
    InvalidConfig(String),
}

Errors returned by the 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.

Protocol(ProtocolError)

JSON-RPC transport or protocol violation.

Rpc

The CLI returned a JSON-RPC error response.

Fields

code: i32

JSON-RPC error code.

message: String

Human-readable error message.

Session(SessionError)

Session-scoped error (not found, agent error, timeout, etc.).

Io(Error)

I/O error on the stdio transport or during process spawn.

Json(Error)

Failed to serialize or deserialize a JSON-RPC message.

BinaryNotFound

A required binary was not found on the system.

Fields

name: &'static str

Binary name that was searched for.

hint: &'static str

Guidance on how to install or configure the binary.

InvalidConfig(String)

Invalid combination of ClientOptions supplied to Client::start. Surfaces consumer-side configuration errors that would otherwise produce confusing runtime failures (e.g. a connection token paired with stdio transport).

Implementations

impl Error

pub fn is_transport_failure(&self) -> bool

Returns true if this error indicates the transport is broken — the CLI process exited, the connection was lost, or an I/O failure occurred. Callers should discard the client and create a fresh one.

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.