Enum Error 

#[non_exhaustive]
pub enum Error {
    Connection(String),
    Timeout(String),
    Box {
        status: u16,
        message: String,
    },
    UnsupportedByBox {
        message: String,
    },
    Decode(String),
    NotSupportedByBox {
        feature: &'static str,
        details: &'static str,
    },
    AuthRequired {
        box_host: String,
        auth_url: String,
        message: String,
    },
    Config(String),
    Stream(String),
}

All the ways a Lager box interaction can fail.

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.

Connection(String)

The box could not be reached at all (DNS, TCP connect, transport failure). Check network/Tailscale and that the box is online.

Timeout(String)

The HTTP request timed out client-side. For long-running actions (energy integration windows, wait_for_level) the crate widens the timeout automatically, so hitting this usually means the box stalled.

Box

The box accepted the request but reported failure. Carries the HTTP status and the box’s error message. Note the box can report failure with HTTP 200 (e.g. a cross-role instrument conflict); this variant covers that too.

Fields

status: u16

HTTP status code of the response (200 is possible: the box reports some conflicts as success: false with HTTP 200).

message: String

Human-readable error message from the box.

UnsupportedByBox

HTTP 501: this box image does not serve the endpoint. The box needs a software update.

Fields

message: String

Human-readable error message from the box.

Decode(String)

The box’s response could not be parsed into the expected shape.

NotSupportedByBox

The net type exists in the Lager Python API but its box endpoint is not yet available on the :9000 HTTP API, so this crate ships it as a documented stub. See MISSING_ENDPOINTS.md in the crate repository.

Fields

feature: &'static str

Which net/feature was invoked (e.g. "debug").

details: &'static str

What the box side would need to expose for this to work.

AuthRequired

The box sits behind an authenticating gateway and the request was denied (HTTP 401 with the X-Gateway-Auth-Url discovery header), with no usable credential available. Sign in with the Lager CLI (lager login <auth_url>) — this crate reuses the CLI’s session — or supply a token via LagerBoxBuilder::bearer_token / LAGER_GATEWAY_TOKEN.

Fields

box_host: String

Hostname of the gated box.

auth_url: String

The auth server URL announced by the gateway.

message: String

What happened (no credential vs. rejected credential).

Config(String)

Client-side configuration problem (bad host string, missing env var).

Stream(String)

A streaming session (UART) reported an error, e.g. the net is in use by another session or the device disappeared.

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, f: &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(e: Error) -> Self

Converts to this type from the input type.