Enum RealtimeErrorKind 

#[non_exhaustive]
pub enum RealtimeErrorKind {
    WebSocket {
        source: Error,
    },
    Protocol(String),
    Timeout {
        operation: &'static str,
    },
    Closed,
}

Concrete error categories for the realtime (WebSocket) transport.

Kept separate from ZaiError so callers can introspect the failure mode without matching on the full enum, and so the realtime module can construct rich errors without touching HTTP-specific machinery.

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.

WebSocket

Available on crate feature realtime only.

Low-level WebSocket error (connect/handshake/read/write). The original tungstenite error is kept as the #[source] so the full chain survives propagation. Only available with the realtime feature.

Fields

source: Error

The underlying tungstenite error.

Protocol(String)

Protocol violation — unexpected or malformed server event.

Timeout

A realtime connect, write, or close operation exceeded its deadline.

Fields

operation: &'static str

Operation whose deadline elapsed.

Closed

The WebSocket session has been closed.

Trait Implementations

impl Debug for RealtimeErrorKind

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

Formats the value using the given formatter.

impl Display for RealtimeErrorKind

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

Formats the value using the given formatter.

impl Error for RealtimeErrorKind

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<RealtimeErrorKind> for ZaiError

Convert from a realtime transport error kind into a ZaiError.

fn from(kind: RealtimeErrorKind) -> Self

Converts to this type from the input type.