Enum BoxxkiteError 

pub enum BoxxkiteError {
    Api {
        status: u16,
        code: String,
        message: String,
        retryable: bool,
        remediation: Option<String>,
    },
    Connection(Error),
    Decode(Error),
    WebSocket(Error),
    EventStream(Box<Error>),
    Config(String),
}

Everything this crate’s Result<T, BoxxkiteError> can fail with.

Mirrors sdk-python’s BoxxkiteApiError/BoxxkiteConnectionError split (both subclass BoxxkiteError there; here both are variants of one enum, the idiomatic Rust shape for a small, closed set of error kinds).

Variants

Api

The control-plane responded with a non-2xx status. code is the machine-readable error.code field from the response envelope ({"error": {"code", "message"}}) – see docs/API.md’s “Error codes” table for the full list this API can return.

Fields

status: u16

code: String

message: String

retryable: bool

remediation: Option<String>

Connection(Error)

The request never reached the control-plane, or its response couldn’t be read (DNS failure, connection refused, TLS error, timeout, etc).

Decode(Error)

A response body that was expected to be well-formed JSON wasn’t, or couldn’t be deserialized into the expected shape.

WebSocket(Error)

A WebSocket-based call (takeover) failed to connect or errored mid-stream.

EventStream(Box<Error>)

The Server-Sent Events stream (watch) errored. Boxed: the largest variant of the underlying reqwest_eventsource::Error embeds a full reqwest::Response, which would otherwise make every BoxxkiteError (including cheap ones like Config) pay for that size on the stack.

Config(String)

A caller-supplied argument was invalid before any request was even sent – e.g. a non-https:// base_url that isn’t localhost (see ClientBuilder::build’s doc comment for why this is rejected rather than silently sent in cleartext).

Implementations

impl BoxxkiteError

pub fn code(&self) -> Option<&str>

The machine-readable error code from an Api variant, if this is one – e.g. "concurrent_sandbox_limit_reached". None for every other variant.

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

The HTTP status code from an Api variant, if this is one.

pub fn retryable(&self) -> bool

pub fn remediation(&self) -> Option<&str>

Trait Implementations

impl Debug for BoxxkiteError

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

Formats the value using the given formatter.

impl Display for BoxxkiteError

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

Formats the value using the given formatter.

impl Error for BoxxkiteError

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 BoxxkiteError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BoxxkiteError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BoxxkiteError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BoxxkiteError

fn from(err: Error) -> Self

Converts to this type from the input type.