Enum RelayError 

pub enum RelayError {
    Api {
        code: String,
        message: String,
        status: u16,
    },
    Http(Error),
    Json(Error),
    Url(ParseError),
    WebSocket(Box<Error>),
    InvalidResponse(String),
    NotConnected,
}

Errors that can occur when using the RelayCast SDK.

Variants

Api

An error returned by the RelayCast API.

Fields

code: String

The error code from the API.

message: String

The error message from the API.

status: u16

The HTTP status code.

Http(Error)

An HTTP request error.

Json(Error)

A JSON serialization/deserialization error.

Url(ParseError)

A URL parsing error.

WebSocket(Box<Error>)

A WebSocket error.

InvalidResponse(String)

The response was invalid or malformed.

NotConnected

The WebSocket is not connected.

Implementations

impl RelayError

pub fn api( code: impl Into<String>, message: impl Into<String>, status: u16, ) -> Self

Create a new API error.

pub fn is_retryable(&self) -> bool

Check if this is a retryable error.

pub fn is_rate_limited(&self) -> bool

Check if this is a rate-limit error (HTTP 429).

pub fn is_not_found(&self) -> bool

Check if this is a not-found error (HTTP 404).

pub fn is_auth_rejection(&self) -> bool

Check if this is an authentication/authorization rejection (HTTP 401 or 403).

pub fn is_conflict(&self) -> bool

Check if this is a conflict error (HTTP 409).

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

Get the HTTP status code, if this is an API error.

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

Get the API error code, if this is an API error.

Trait Implementations

impl Debug for RelayError

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

Formats the value using the given formatter.

impl Display for RelayError

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

Formats the value using the given formatter.

impl Error for RelayError

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 RelayError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RelayError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RelayError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for RelayError

fn from(source: ParseError) -> Self

Converts to this type from the input type.