Struct WebSocketMessage 

pub struct WebSocketMessage {
    pub event: String,
    pub data: Option<Value>,
    pub channel: Option<String>,
    pub symbol: Option<String>,
    pub id: Option<String>,
}

WebSocket message wrapper (incoming messages)

Fields

event: String

Event type (e.g., “data”, “subscribed”, “error”, “authenticated”, “pong”)

data: Option<Value>

Message data (varies by event type)

channel: Option<String>

Channel (for data events)

symbol: Option<String>

Symbol (for data events)

id: Option<String>

Subscription ID (for subscribed events)

Implementations

impl WebSocketMessage

pub fn is_authenticated(&self) -> bool

Check if this is an authentication success message

pub fn is_error(&self) -> bool

Check if this is an error message

pub fn is_data(&self) -> bool

Check if this is a data message

pub fn is_pong(&self) -> bool

Check if this is a pong message. With the activity-timer health check the SDK never sends internal pings, so any pong arriving on this connection is a response to a user-initiated ping(state) and is forwarded to user message callbacks unchanged.

pub fn is_heartbeat(&self) -> bool

Check if this is a server-initiated heartbeat ({"event":"heartbeat"}). Heartbeats arrive every ~30 seconds and carry a microsecond timestamp in data.time. They are forwarded to user message callbacks so callers can use them for latency measurement or clock alignment.

pub fn is_subscribed(&self) -> bool

Check if this is a subscribed confirmation

pub fn error_message(&self) -> Option<String>

Get error message if this is an error

Trait Implementations

impl Clone for WebSocketMessage

fn clone(&self) -> WebSocketMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSocketMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<WebSocketMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WebSocketMessage

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.