Enum RealtimeError 

#[non_exhaustive]
pub enum RealtimeError {
    InvalidUrl {
        url: String,
        message: String,
    },
    WebSocket(Box<Error>),
    InvalidHeaderValue {
        field: &'static str,
    },
    Protocol(DecodeError),
    MissingResult,
    UnexpectedResult {
        method: &'static str,
        expected: &'static str,
        actual: &'static str,
    },
    Timeout {
        operation: &'static str,
        timeout: Duration,
    },
    ConnectionError {
        reason: i32,
        reason_name: String,
        friendly: String,
    },
    ConnectionClosed,
    RpcError {
        code: i32,
        error_code: i32,
        error_name: String,
        message: String,
        friendly: String,
    },
}

Error returned by realtime connection and RPC operations.

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.

InvalidUrl

Invalid realtime WebSocket URL supplied to a realtime client builder.

Fields

url: String

Original URL value supplied by the caller.

message: String

Human-readable validation failure.

WebSocket(Box<Error>)

WebSocket transport error.

InvalidHeaderValue

A validated client identity could not be represented as a realtime header.

Fields

field: &'static str

Name of the invalid realtime header field.

Protocol(DecodeError)

Protobuf decode error for a server message.

MissingResult

The server returned an RPC result envelope without a result body.

UnexpectedResult

The server returned a result oneof that does not match the requested method.

Fields

method: &'static str

Requested RPC method.

expected: &'static str

Expected result oneof variant.

actual: &'static str

Actual result oneof variant.

Timeout

A realtime operation exceeded its configured timeout.

Fields

operation: &'static str

Operation that timed out.

timeout: Duration

Configured timeout.

ConnectionError

The realtime server rejected the connection.

Fields

reason: i32

Numeric connection-error reason.

reason_name: String

Stable protobuf enum name for the reason.

friendly: String

Human-readable formatted error.

ConnectionClosed

The realtime connection closed before the requested operation completed.

RpcError

The realtime server returned an RPC error for a request.

Fields

code: i32

Transport-level status code.

error_code: i32

Inline RPC error code.

error_name: String

Stable protobuf enum name for the RPC error.

message: String

Server-provided error message.

friendly: String

Human-readable formatted error.

Trait Implementations

impl Debug for RealtimeError

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

Formats the value using the given formatter.

impl Display for RealtimeError

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

Formats the value using the given formatter.

impl Error for RealtimeError

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<DecodeError> for RealtimeError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for RealtimeError

fn from(error: Error) -> Self

Converts to this type from the input type.