Enum Error 

pub enum Error {
    Authentication {
        message: String,
    },
    TwoFactorRequired,
    SessionExpired,
    InvalidApiKey,
    WrongAuthStrategy {
        expected: String,
        got: String,
    },
    Transport(Error),
    InvalidUrl(ParseError),
    Timeout {
        timeout_secs: u64,
    },
    Tls(String),
    RateLimited {
        retry_after_secs: u64,
    },
    Integration {
        message: String,
        code: Option<String>,
        status: u16,
    },
    LegacyApi {
        message: String,
    },
    WebSocketConnect(String),
    WebSocketClosed {
        code: u16,
        reason: String,
    },
    Deserialization {
        message: String,
        body: String,
    },
    UnsupportedOperation(&'static str),
}

Top-level error type for the unifly-api crate.

Covers every failure mode across all API surfaces: authentication, transport, Integration API, Legacy API, WebSocket, and cloud. unifly-core maps these into user-facing diagnostics.

Variants

Authentication

Login failed (wrong credentials, account locked, etc.)

Fields

message: String

TwoFactorRequired

2FA token required but not provided.

SessionExpired

Session has expired (cookie expired or revoked).

InvalidApiKey

Invalid API key (rejected by controller).

WrongAuthStrategy

Wrong credential type for the requested operation.

Fields

expected: String

got: String

Transport(Error)

HTTP transport error (connection refused, DNS failure, etc.)

InvalidUrl(ParseError)

URL parsing error.

Timeout

Request timed out.

Fields

timeout_secs: u64

Tls(String)

TLS handshake or certificate error.

RateLimited

Rate limited by the cloud API. Includes retry-after in seconds.

Fields

retry_after_secs: u64

Integration

Structured error from the Integration API.

Fields

message: String

code: Option<String>

status: u16

LegacyApi

Error from the legacy API (parsed from the {meta: {rc, msg}} envelope).

Fields

message: String

WebSocketConnect(String)

WebSocket connection failed.

WebSocketClosed

WebSocket closed unexpectedly.

Fields

code: u16

reason: String

Deserialization

JSON deserialization failed, with the raw body for debugging.

Fields

message: String

body: String

UnsupportedOperation(&'static str)

Operation not supported on this controller platform.

Implementations

impl Error

pub fn is_auth_expired(&self) -> bool

Returns true if this error indicates auth has expired and re-authentication might resolve it.

pub fn is_transient(&self) -> bool

Returns true if this is a transient error worth retrying.

pub fn is_not_found(&self) -> bool

Returns true if this is a “not found” error.

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

Extract the API error code, if available.

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, __formatter: &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(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(source: ParseError) -> Self

Converts to this type from the input type.