Enum Error 

#[non_exhaustive]
pub enum Error {
    Configuration(String),
    Unauthorized {
        method: Method,
        url: Box<Url>,
    },
    Forbidden {
        method: Method,
        url: Box<Url>,
    },
    HttpStatus {
        method: Method,
        url: Box<Url>,
        status: StatusCode,
    },
    Transport {
        method: Method,
        url: Box<Url>,
        source: Error,
    },
    ResponseTooLarge {
        method: Method,
        url: Box<Url>,
        limit: usize,
        content_length: Option<u64>,
    },
    Encode {
        operation: &'static str,
        source: Error,
    },
    Api {
        method: Method,
        url: Box<Url>,
        message: String,
    },
    Decode {
        method: Method,
        url: Box<Url>,
        source: Error,
    },
    Utf8 {
        method: Method,
        url: Box<Url>,
        source: FromUtf8Error,
    },
    WebSocketConnectTimeout {
        url: Box<Url>,
        timeout: Duration,
    },
    WebSocket {
        url: Box<Url>,
        source: Box<Error>,
    },
    Proxy {
        scheme: ProxyScheme,
        url: Box<Url>,
        source: Box<ProxyError>,
    },
    EventDecode {
        message_type: Option<String>,
        source: Error,
    },
    UnexpectedWebSocketFrame {
        url: Box<Url>,
        kind: &'static str,
    },
    MissingObject {
        method: Method,
        url: Box<Url>,
    },
}

Errors returned by the SDK.

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.

Configuration(String)

The client configuration is invalid.

Unauthorized

The panel rejected the caller’s credentials or session.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

Forbidden

The panel rejected a request, commonly due to an invalid CSRF token.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

HttpStatus

The panel returned an unsuccessful HTTP status.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

status: StatusCode

Response status.

Transport

The request could not be sent or its body could not be read.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

source: Error

Underlying HTTP client error.

ResponseTooLarge

The response body exceeded the configured in-memory size limit.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL, redacted for public subscription routes.

limit: usize

Configured maximum response body size in bytes.

content_length: Option<u64>

Server-advertised body size, when a Content-Length was present.

Encode

A request value could not be encoded in the endpoint’s wire format.

Fields

operation: &'static str

Human-readable operation name.

source: Error

Underlying JSON encoding error.

Api

The panel returned HTTP success with success: false.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

message: String

Human-readable message returned by 3x-ui.

Decode

The panel response did not match the documented schema.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

source: Error

JSON decoding error.

Utf8

A text endpoint returned bytes that are not valid UTF-8.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Redacted request URL.

source: FromUtf8Error

Underlying UTF-8 decoding error.

WebSocketConnectTimeout

Establishing the authenticated WebSocket exceeded the configured connection timeout.

Fields

url: Box<Url>

WebSocket endpoint.

timeout: Duration

Configured connection timeout.

WebSocket

A WebSocket handshake or frame operation failed.

Fields

url: Box<Url>

WebSocket endpoint.

source: Box<Error>

Underlying protocol/transport error.

Proxy

An explicit proxy could not establish a WebSocket tunnel.

Fields

scheme: ProxyScheme

Proxy protocol in use. The proxy endpoint is deliberately omitted.

url: Box<Url>

Target WebSocket endpoint, never the proxy endpoint.

source: Box<ProxyError>

Underlying proxy transport or negotiation failure.

EventDecode

A WebSocket text message did not match its source-defined JSON shape.

Fields

message_type: Option<String>

Message name when the envelope was valid enough to identify it.

source: Error

Underlying JSON decoding error.

UnexpectedWebSocketFrame

The panel sent a data-frame format not used by the v3.8.5 protocol.

Fields

url: Box<Url>

WebSocket endpoint.

kind: &'static str

Human-readable frame kind.

MissingObject

A successful response omitted its documented obj value.

Fields

method: Method

HTTP method used for the request.

url: Box<Url>

Request URL.

Implementations

impl Error

pub const fn kind(&self) -> ErrorKind

Returns the stable category of this error.

pub const fn status(&self) -> Option<StatusCode>

Returns the HTTP status that caused this error, when available.

Authentication errors report 401 or 403 even though they have dedicated variants. Application-level Error::Api responses used HTTP success and therefore return None.

pub const fn method(&self) -> Option<&Method>

Returns the HTTP method associated with the failed operation.

pub fn url(&self) -> Option<&Url>

Returns the request or WebSocket URL associated with the failure.

pub const fn is_unauthorized(&self) -> bool

Returns true when authentication must be supplied or refreshed.

pub const fn is_forbidden(&self) -> bool

Returns true when the operation was rejected with HTTP 403.

pub const fn is_rate_limited(&self) -> bool

Returns true when the panel asked the caller to slow down.

pub const fn is_response_too_large(&self) -> bool

Returns true when the response body exceeded its configured limit.

pub const fn response_body_limit(&self) -> Option<usize>

Returns the configured response body limit that was exceeded.

pub const fn advertised_content_length(&self) -> Option<u64>

Returns the server-advertised Content-Length for an oversized body.

pub fn is_server_error(&self) -> bool

Returns true for an HTTP 5xx response.

pub fn is_timeout(&self) -> bool

Returns true when an HTTP or WebSocket transport timed out.

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.