Enum SailError 

#[non_exhaustive]
pub enum SailError {
    Config {
        message: String,
    },
    Internal {
        message: String,
    },
    Transport {
        kind: TransportKind,
        message: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
    Creation {
        message: String,
        status: u16,
        body: Value,
    },
    NotFound {
        message: String,
    },
    PermissionDenied {
        message: String,
    },
    FileNotFound {
        message: String,
    },
    InvalidArgument {
        message: String,
    },
    ImageBuild {
        message: String,
    },
    Api {
        status: u16,
        message: String,
        body: Value,
    },
    ExecRequestNotFound {
        message: String,
    },
    Terminated {
        message: String,
    },
    HostLost {
        message: String,
    },
    BrokenPipe {
        message: String,
    },
    Execution {
        code: RpcStatus,
        detail: String,
    },
}

The canonical Sail error. Variants carry structured fields so bindings can populate their own exception attributes without parsing strings.

Display is for Rust logs only; bindings format their own user-facing text.

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.

Config

Configuration/usage error (e.g. a missing API key).

Fields

message: String

Human-readable description of the misconfiguration.

Internal

Unexpected internal failure (client build, TLS config, invariant).

Fields

message: String

Human-readable description of the internal failure.

Transport

Dial-time transport failure. source is the underlying transport error (e.g. the originating tonic::Status) for Rust callers.

Fields

kind: TransportKind

Whether the transport failed by timeout or by connection error.

message: String

Human-readable description of the transport failure.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

The underlying transport error, retained for Rust callers; None when no originating error was available.

Creation

Sailbox creation failed (non-2xx on create).

Fields

message: String

Human-readable description of the creation failure.

status: u16

HTTP status code returned by the create request.

body: Value

Parsed response body from the failed create request.

NotFound

A resource was not found (404 on get / unknown id across orgs).

Fields

message: String

Human-readable description of the missing resource.

PermissionDenied

A credential problem: missing/invalid API key or insufficient scope.

Fields

message: String

Human-readable description of the credential or scope problem.

FileNotFound

A file operation referenced a path that does not exist.

Fields

message: String

Human-readable description of the missing path.

InvalidArgument

A request argument was rejected as invalid.

Fields

message: String

Human-readable description of why the argument was rejected.

ImageBuild

A custom image build failed (the build reported failed).

Fields

message: String

Human-readable build failure detail.

Api

Any other non-2xx API response.

Fields

status: u16

HTTP status code returned by the API.

message: String

Human-readable description of the API failure.

body: Value

Parsed response body from the failed API request.

ExecRequestNotFound

A wait referenced an unknown exec request.

Fields

message: String

Human-readable description of the unknown exec request.

Terminated

The Sailbox no longer exists on the worker.

Fields

message: String

Human-readable description noting the Sailbox is gone.

HostLost

The host machine running the Sailbox was lost; output is unrecoverable.

Fields

message: String

Human-readable description of the host loss.

BrokenPipe

A stdin write hit a command that already finished or closed its stdin.

Fields

message: String

Human-readable description of the broken-pipe condition.

Execution

Any other exec-RPC failure, classified by RPC status code.

Fields

code: RpcStatus

The RPC status code that classifies the failure.

detail: String

Human-readable detail describing the failure.

Implementations

impl SailError

pub fn retryable(&self) -> bool

Whether retrying the same call may succeed, so autonomous callers can branch without matching variants or parsing messages. Advisory and conservative: true for transport failures, HTTP 429 and gateway statuses (502-504), and unavailable/aborted/deadline-exceeded RPC failures; false everywhere the failure is deterministic (bad argument, missing resource, permission). resource-exhausted stays false even though its HTTP twin 429 is true: gRPC surfaces deterministic message-size violations under the same code as rate limits, so it cannot be classified as transient. The SDK’s built-in retry already covers the transient window for most calls; this classifies what leaks past it.

Trait Implementations

impl Debug for SailError

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

Formats the value using the given formatter.

impl Display for SailError

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

Formats the value using the given formatter.

impl Error for SailError

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.