Enum RealtimeError 

#[non_exhaustive]
pub enum RealtimeError {
    MissingAuthToken,
    Endpoint(Error),
    Transport,
    Handshake(&'static str),
    Protocol(&'static str),
    Decode(Error),
    Encode(Error),
    AlreadyConnected,
    ConnectionCancelled,
    ConnectionTimedOut,
    NotConnected,
    WrongHub,
    SendQueueFull,
    SendClosed,
    EventQueueFull,
    TransportGapPending,
    EventReceiverClosed,
    PendingInvocationCapacity,
    IdentifierCapacity,
    OutboundMessageTooLarge {
        max_bytes: usize,
    },
    InvocationRejected {
        target: String,
    },
    InvocationTimedOut {
        target: String,
    },
    InvocationSessionEnded {
        target: String,
    },
    Close,
}

Errors returned by the real-time transport.

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.

MissingAuthToken

Authentication has not produced a bearer token.

Endpoint(Error)

Endpoint configuration could not form the hub URL.

Transport

The WebSocket transport failed. Details are intentionally omitted because the connection URL contains a bearer token.

Handshake(&'static str)

The SignalR handshake failed.

Protocol(&'static str)

A SignalR or event payload was malformed.

Decode(Error)

JSON decoding failed.

Encode(Error)

JSON encoding failed before an invocation reached the writer queue.

AlreadyConnected

The client is already connected.

ConnectionCancelled

Connection setup was cancelled by a concurrent disconnect or shutdown.

ConnectionTimedOut

The WebSocket upgrade did not complete within its bounded deadline.

NotConnected

The client is not connected.

WrongHub

The typed subscription does not belong to this client’s hub.

SendQueueFull

The bounded writer queue is full.

SendClosed

The writer task or channel closed.

EventQueueFull

The bounded event queue is full and a transport gap was latched.

TransportGapPending

Reconnection is fenced until the caller acknowledges a transport gap.

EventReceiverClosed

The single event receiver was dropped.

PendingInvocationCapacity

The pending invocation bound was reached.

IdentifierCapacity

A monotonic transport identifier reached its numeric bound.

OutboundMessageTooLarge

An invocation exceeded the bounded outbound message size.

Fields

max_bytes: usize

Maximum encoded invocation size, including the SignalR terminator.

InvocationRejected

A SignalR invocation was rejected by the provider.

Fields

target: String

Provider invocation target.

InvocationTimedOut

A SignalR invocation timed out.

Fields

target: String

Provider invocation target.

InvocationSessionEnded

The session ended before an invocation completed.

Fields

target: String

Provider invocation target.

Close

Graceful close did not complete.

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.