Enum BitmexWsMessage 

pub enum BitmexWsMessage {
    Table(BitmexTableMessage),
    Welcome {
        info: String,
        version: String,
        timestamp: DateTime<Utc>,
        docs: String,
        heartbeat_enabled: bool,
        limit: BitmexRateLimit,
    },
    Subscription {
        success: bool,
        subscribe: Option<String>,
        error: Option<String>,
    },
    Error {
        status: u16,
        error: String,
        meta: HashMap<String, String>,
        request: BitmexHttpRequest,
    },
    Reconnected,
}

Represents all possible message types from the BitMEX WebSocket API.

Variants

Table(BitmexTableMessage)

Table websocket message.

Welcome

Initial welcome message received when connecting to the WebSocket.

Fields

info: String

Welcome message text.

version: String

API version string.

timestamp: DateTime<Utc>

Server timestamp.

docs: String

Link to API documentation.

heartbeat_enabled: bool

Whether heartbeat is enabled for this connection.

limit: BitmexRateLimit

Rate limit information.

Subscription

Subscription response messages.

Fields

success: bool

Whether the subscription request was successful.

subscribe: Option<String>

The subscription topic if successful.

error: Option<String>

Error message if subscription failed.

Error

WebSocket error message.

Fields

status: u16

error: String

meta: HashMap<String, String>

request: BitmexHttpRequest

Reconnected

Indicates a WebSocket reconnection has occurred.

Trait Implementations

impl Debug for BitmexWsMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BitmexWsMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BitmexWsMessage

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

Formats the value using the given formatter.