Enum WsEvent 

pub enum WsEvent {
    Connecting,
    Connected,
    Disconnected,
    Reconnecting {
        attempt: u32,
        delay: Duration,
        error: Option<String>,
    },
    ReconnectSuccess,
    ReconnectFailed {
        attempt: u32,
        error: String,
        is_permanent: bool,
    },
    ReconnectExhausted {
        total_attempts: u32,
        last_error: String,
    },
    SubscriptionRestored,
    PermanentError {
        error: String,
    },
    Shutdown,
}

WebSocket connection event types.

These events are emitted during the WebSocket connection lifecycle to notify listeners about state changes, reconnection attempts, and errors.

Example

use ccxt_core::ws_client::WsEvent;
use std::time::Duration;

fn handle_event(event: WsEvent) {
    match event {
        WsEvent::Connecting => println!("Connecting..."),
        WsEvent::Connected => println!("Connected!"),
        WsEvent::Disconnected => println!("Disconnected"),
        WsEvent::Reconnecting { attempt, delay, error } => {
            println!("Reconnecting (attempt {}), delay: {:?}, error: {:?}",
                     attempt, delay, error);
        }
        WsEvent::ReconnectSuccess => println!("Reconnected successfully"),
        WsEvent::ReconnectFailed { attempt, error, is_permanent } => {
            println!("Reconnect failed (attempt {}): {}, permanent: {}",
                     attempt, error, is_permanent);
        }
        WsEvent::ReconnectExhausted { total_attempts, last_error } => {
            println!("All {} reconnect attempts exhausted: {}",
                     total_attempts, last_error);
        }
        WsEvent::SubscriptionRestored => println!("Subscriptions restored"),
        WsEvent::PermanentError { error } => {
            println!("Permanent error (no retry): {}", error);
        }
        WsEvent::Shutdown => println!("Shutdown complete"),
    }
}

Variants

Connecting

Connection attempt started.

Emitted when the client begins establishing a WebSocket connection.

Connected

Connection established successfully.

Emitted when the WebSocket handshake completes and the connection is ready.

Disconnected

Connection closed.

Emitted when the WebSocket connection is closed, either gracefully or due to an error.

Reconnecting

Reconnection in progress.

Emitted before each reconnection attempt with details about the attempt.

Fields

attempt: u32

Current reconnection attempt number (1-indexed).

delay: Duration

Delay before this reconnection attempt (calculated by backoff strategy).

error: Option<String>

Error that triggered the reconnection (if any).

ReconnectSuccess

Reconnection succeeded.

Emitted when a reconnection attempt successfully establishes a new connection.

ReconnectFailed

Single reconnection attempt failed.

Emitted when a reconnection attempt fails. More attempts may follow unless is_permanent is true or max attempts is reached.

Fields

attempt: u32

The attempt number that failed (1-indexed).

error: String

Error message describing the failure.

is_permanent: bool

Whether this is a permanent error that should not be retried.

If true, no further reconnection attempts will be made.

ReconnectExhausted

All reconnection attempts exhausted.

Emitted when the maximum number of reconnection attempts has been reached without successfully reconnecting. No further automatic reconnection will occur.

Fields

total_attempts: u32

Total number of reconnection attempts made.

last_error: String

The last error encountered.

SubscriptionRestored

Subscriptions restored after reconnection.

Emitted after a successful reconnection when all previous subscriptions have been re-established.

PermanentError

Permanent error occurred (no retry).

Emitted when a permanent error is encountered that cannot be recovered through retries (e.g., authentication failure, invalid credentials).

Fields

error: String

Error message describing the permanent failure.

Shutdown

Shutdown completed.

Emitted when the WebSocket client has completed its graceful shutdown process, including cancelling pending operations and closing connections.

Implementations

impl WsEvent

pub fn is_connecting(&self) -> bool

Returns true if this is a Connecting event.

pub fn is_connected(&self) -> bool

Returns true if this is a Connected event.

pub fn is_disconnected(&self) -> bool

Returns true if this is a Disconnected event.

pub fn is_reconnecting(&self) -> bool

Returns true if this is a Reconnecting event.

pub fn is_reconnect_success(&self) -> bool

Returns true if this is a ReconnectSuccess event.

pub fn is_reconnect_failed(&self) -> bool

Returns true if this is a ReconnectFailed event.

pub fn is_reconnect_exhausted(&self) -> bool

Returns true if this is a ReconnectExhausted event.

pub fn is_subscription_restored(&self) -> bool

Returns true if this is a SubscriptionRestored event.

pub fn is_permanent_error(&self) -> bool

Returns true if this is a PermanentError event.

pub fn is_shutdown(&self) -> bool

Returns true if this is a Shutdown event.

pub fn is_error(&self) -> bool

Returns true if this event indicates an error condition.

This includes ReconnectFailed, ReconnectExhausted, and PermanentError.

pub fn is_terminal(&self) -> bool

Returns true if this event indicates a terminal state.

Terminal states are those where no further automatic recovery will occur: ReconnectExhausted, PermanentError, and Shutdown.

Trait Implementations

impl Clone for WsEvent

fn clone(&self) -> WsEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WsEvent

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

Formats the value using the given formatter.

impl Display for WsEvent

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

Formats the value using the given formatter.