Enum HeyoError 

pub enum HeyoError {
    Authentication,
    InvalidArgument(String),
    NotFound(String),
    Api {
        status: u16,
        message: String,
        body: Option<Value>,
    },
    Timeout(Duration, String),
    SandboxFailed {
        sandbox_id: String,
        reason: String,
    },
    Connection(String),
    SessionExpired {
        session_id: Option<String>,
    },
    ShellExit(i32),
    CheckinConflict {
        expected: Option<i64>,
        current: i64,
    },
}

Every fallible call in the SDK returns Result<T, HeyoError>. Variants mirror the TypeScript SDK’s error classes so the same recovery patterns translate across languages.

Variants

Authentication

No API key was provided and HEYO_API_KEY is unset.

InvalidArgument(String)

4xx other than 401/403/404 (e.g. 400 Bad Request, 422 Unprocessable).

NotFound(String)

404 Not Found.

Api

5xx, network error, or non-classified HTTP failure.

Fields

status: u16

message: String

body: Option<Value>

Timeout(Duration, String)

A wait_for_* call exceeded its budget.

SandboxFailed

Sandbox provisioning ended in failed.

Fields

sandbox_id: String

reason: String

Connection(String)

Shell-stream WebSocket could not be (re)established.

SessionExpired

Server refused to resume the shell session.

Fields

session_id: Option<String>

ShellExit(i32)

Remote shell exited unexpectedly.

CheckinConflict

Database::checkin rejected because data_version advanced.

Fields

expected: Option<i64>

current: i64

Trait Implementations

impl Debug for HeyoError

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

Formats the value using the given formatter.

impl Display for HeyoError

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

Formats the value using the given formatter.

impl Error for HeyoError

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.