Enum SolariError 

#[non_exhaustive]
pub enum SolariError {
    Auth {
        status: u16,
        message: String,
        code: Option<String>,
    },
    Plan {
        status: u16,
        message: String,
        code: Option<String>,
    },
    ConcurrencyLimit {
        status: u16,
        message: String,
        code: Option<String>,
    },
    NoCapacity {
        status: u16,
        message: String,
        code: Option<String>,
    },
    Gateway {
        status: u16,
        message: String,
        code: Option<String>,
    },
    Action {
        method: String,
        message: String,
        code: Option<String>,
    },
    Timeout {
        method: String,
        timeout_ms: u64,
    },
    Connection {
        message: String,
    },
    Git {
        message: String,
    },
    Other(String),
    Validation {
        message: String,
    },
}

Every error raised by the SDK. Corresponds to the SolariError hierarchy in the TypeScript reference (AuthError / PlanError / ConcurrencyLimitError / NoCapacityError / GatewayError / ActionError / TimeoutError / ConnectionError).

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.

Auth

HTTP 401 — the API key was missing, malformed, or rejected.

Fields

status: u16

message: String

code: Option<String>

Plan

The plan does not allow this: HTTP 402 (FeatureRequiresPlan, InsufficientCredit) or 403 NotEntitled (the plan does not include sandboxes/desktops). status is the status the gateway really sent.

Fields

status: u16

message: String

code: Option<String>

ConcurrencyLimit

HTTP 429 ConcurrencyLimitExceeded (or a 429 with no code) — the org is at its session cap. NOT retryable. Other 429s (TooManyExecutions, a per-sandbox limit, ObjectLimit, the template caps) are Gateway errors with the gateway’s code.

Fields

status: u16

message: String

code: Option<String>

NoCapacity

HTTP 503 NoCapacity / StartTimeout (or a 503 with no code) — no host available (retryable). Other 503s (SandboxUnavailable, StoreUnavailable, AdmissionUnavailable, DependencyUnavailable) are Gateway errors: the sandbox, store or admission service is unavailable, which is not a capacity problem.

Fields

status: u16

message: String

code: Option<String>

Gateway

Any other non-2xx gateway response (incl. 404/405/409/501).

Fields

status: u16

message: String

code: Option<String>

Action

A control-WS RPC replied {ok:false}.

Fields

method: String

message: String

code: Option<String>

Timeout

A call (or connect) did not complete within its timeout.

Fields

method: String

timeout_ms: u64

Connection

The control WebSocket is not open (never connected, or dropped).

Fields

message: String

Git

A git subcommand exited non-zero (message includes sub/exit/detail).

Fields

message: String

Other(String)

Anything else (bad response body, internal invariant).

Validation

A caller passed an invalid argument (e.g. a blank session id). Distinct from Other: this is the caller’s input to fix, not an unexpected server response.

Fields

message: String

Implementations

impl SolariError

pub fn status(&self) -> Option<u16>

The gateway HTTP status this error carries, when it is a gateway error.

Trait Implementations

impl Debug for SolariError

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

Formats the value using the given formatter.

impl Display for SolariError

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

Formats the value using the given formatter.

impl Error for SolariError

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.