Enum Error 

#[non_exhaustive]
pub enum Error {
    CliNotFound,
    VersionMismatch {
        found: String,
        required: String,
    },
    JsonRpcModeNotSupported,
    SpawnFailed(Error),
    ProcessExited {
        code: Option<i32>,
        stderr: String,
    },
    ParseError {
        message: String,
        line: String,
    },
    JsonRpcError {
        code: i64,
        message: String,
        data: Option<Value>,
    },
    ProtocolError(String),
    AuthRequired(String),
    AuthFailed(String),
    Io(Error),
    Json(Error),
    NotConnected,
    Transport(String),
    Config(String),
    ImageValidation(String),
    Timeout(String),
    TurnInProgress,
}

All errors that can occur when using gemini-cli-sdk.

The enum is #[non_exhaustive] so that new variants can be added in minor releases without breaking downstream match arms.

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 gemini binary could not be located on PATH.

VersionMismatch

The located binary is older than the minimum required version.

Fields

found: String

required: String

JsonRpcModeNotSupported

The CLI binary does not accept --experimental-acp (JSON-RPC mode).

SpawnFailed(Error)

tokio::process::Command::spawn failed.

This variant carries the underlying std::io::Error as a source (accessible via std::error::Error::source) but does not generate a blanket From<std::io::Error> impl — that is reserved for Error::Io.

ProcessExited

The Gemini subprocess terminated unexpectedly.

Fields

code: Option<i32>

stderr: String

ParseError

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

Fields

message: String

line: String

JsonRpcError

The server returned a JSON-RPC error object.

Fields

code: i64

message: String

data: Option<Value>

ProtocolError(String)

The wire protocol was violated (unexpected message shape, missing required field, etc.).

AuthRequired(String)

The CLI requires authentication before the JSON-RPC server starts.

AuthFailed(String)

Authentication was attempted but the credentials were rejected.

Io(Error)

A low-level I/O error from reading or writing to the subprocess pipes.

This is the blanket conversion target for std::io::Error via ?.

Json(Error)

A JSON serialisation/deserialisation error.

NotConnected

A method was called before [Client::connect] completed successfully.

Transport(String)

An error originating in the transport layer (framing, flushing, etc.).

Config(String)

The supplied configuration is invalid.

ImageValidation(String)

An image path or content failed validation.

Timeout(String)

An operation exceeded its allotted time.

TurnInProgress

A send_content call was made while a previous turn is still streaming.

The Gemini CLI uses a single shared notification stream per session. Concurrent send_content calls would contend on the internal Mutex, causing the second call to silently hang until the first completes. This variant surfaces the conflict immediately instead.

Implementations

impl Error

pub fn is_process_exit(&self) -> bool

Returns true if this error indicates that the Gemini subprocess has exited.

Examples

use gemini_cli_sdk::errors::Error;

let err = Error::ProcessExited { code: Some(1), stderr: "fatal".into() };
assert!(err.is_process_exit());

assert!(!Error::NotConnected.is_process_exit());

pub fn is_retriable(&self) -> bool

Returns true if the operation that produced this error is safe to retry without modification.

Retriable errors are transient I/O failures, timeouts, and transport disruptions.

Examples

use gemini_cli_sdk::errors::Error;

assert!(Error::Timeout("read".into()).is_retriable());
assert!(!Error::CliNotFound.is_retriable());

pub fn is_auth_error(&self) -> bool

Returns true if this is an authentication-related error.

Examples

use gemini_cli_sdk::errors::Error;

assert!(Error::AuthRequired("login needed".into()).is_auth_error());
assert!(Error::AuthFailed("bad token".into()).is_auth_error());
assert!(!Error::NotConnected.is_auth_error());

pub fn is_jsonrpc_error(&self) -> bool

Returns true if this error originated in the JSON-RPC protocol layer.

Examples

use gemini_cli_sdk::errors::Error;

let rpc = Error::JsonRpcError { code: -32600, message: "Invalid Request".into(), data: None };
assert!(rpc.is_jsonrpc_error());

assert!(Error::ProtocolError("bad frame".into()).is_jsonrpc_error());
assert!(!Error::NotConnected.is_jsonrpc_error());

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.