Enum ApiError 

#[non_exhaustive]
pub enum ApiError {
    RequestError(Error),
    InvalidResponse(Error),
    WebsocketError(Error),
    AuthenticationRefreshFailed(AuthenticationError),
    SinkAlreadyClosed,
}

Errors which can occur when trying to communicate with the Ring API.

This may either be the REST API or the WebSocket API.

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.

RequestError(Error)

When communicating with Ring over a REST API an error occurred.

InvalidResponse(Error)

Decoding the response from a Ring endpoint failed.

WebsocketError(Error)

When communicating with Ring over a WebSocket connection an error occurred.

AuthenticationRefreshFailed(AuthenticationError)

When refreshing the authentication tokens an error occurred.

SinkAlreadyClosed

An attempt to write to a closed WebSocket sink was made.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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 ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.