Enum WsMessage 

#[non_exhaustive]
pub enum WsMessage {
    Heartbeat,
    System(Value),
    MarketData {
        conid: i64,
        payload: Value,
    },
    Order(Value),
    Pnl(Value),
    Other(Value),
    Malformed {
        text: String,
        error: String,
    },
}

A decoded CPAPI frame. Most messages fall into one of the variants below, but the CPAPI occasionally emits payloads we haven’t modelled — those end up in WsMessage::Other.

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.

Heartbeat

Heartbeat pings sent by the server periodically.

System(Value)

System / session status messages (e.g. "topic": "system").

MarketData

Market data tick for a subscribed contract.

Fields

conid: i64

The contract id this tick is for.

payload: Value

The full decoded payload (field codes are string-keyed).

Order(Value)

Order update (working → filled, cancellations, etc).

Pnl(Value)

PnL / account summary update.

Other(Value)

Any message whose topic we didn’t recognise.

Malformed

The socket emitted a frame we couldn’t decode — a text body that wasn’t valid JSON, or a binary frame converted lossily to UTF-8. The decoder’s error is captured alongside the original text so callers can telemeter parse rates.

Fields

text: String

The raw (possibly lossy) text the socket delivered.

error: String

Human-readable reason the decoder gave up — serde JSON error for malformed payloads, a “non-UTF-8 binary frame” marker for binary decoder losses.

Implementations

impl WsMessage

pub fn topic(&self) -> &'static str

Return a static label for the message variant. Useful for tracing::Span::record("topic", ...) and metrics labels.

pub fn as_value(&self) -> Option<&Value>

Borrow the inner Value for variants that carry one. None for WsMessage::Heartbeat and WsMessage::Malformed (which has no parsed value to lend).

Trait Implementations

impl Clone for WsMessage

fn clone(&self) -> WsMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsMessage

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

Formats the value using the given formatter.