Skip to main content

WebSocketMessage

Enum WebSocketMessage 

Source
pub enum WebSocketMessage {
Show 14 variants AggTrade(AggTradeEvent), MarkPrice(MarkPriceEvent), AllMarkPrices(Vec<MarkPriceEvent>), Kline(KlineEvent), MiniTicker(MiniTickerEvent), AllMiniTickers(Vec<MiniTickerEvent>), Ticker(TickerEvent), AllTickers(Vec<TickerEvent>), BookTicker(BookTickerEvent), ForceOrder(ForceOrderEvent), AllForceOrders(Vec<ForceOrderEvent>), PartialDepth(PartialDepthEvent), DiffDepth(DiffDepthEvent), Unknown(Value),
}
Expand description

Typed WebSocket message.

Deserialization dispatches on the e (event_type) field for object messages. Array JSON (all-symbol streams such as !markPrice@arr) is detected by the top-level value being a JSON array and dispatched on the first element’s e.

Special cases without an "e" field (legacy Binance-compatible deployments):

  • PartialDepth — detected by the presence of "lastUpdateId".
  • BookTicker — detected by "u" key with no "e" field. V3 deployments emit "e": "bookTicker" and are dispatched through the normal match path.

Any unrecognised or malformed message is mapped to Unknown(serde_json::Value) and a tracing::warn! is emitted — the SDK never panics on unknown events.

Variants§

§

AggTrade(AggTradeEvent)

Single aggregate trade event ("e": "aggTrade").

§

MarkPrice(MarkPriceEvent)

Single mark price update ("e": "markPriceUpdate").

§

AllMarkPrices(Vec<MarkPriceEvent>)

All-symbol mark price array (!markPrice@arr).

§

Kline(KlineEvent)

Kline/candlestick event ("e": "kline").

§

MiniTicker(MiniTickerEvent)

24-hour mini ticker for a single symbol.

§

AllMiniTickers(Vec<MiniTickerEvent>)

All-symbol 24-hour mini tickers (!miniTicker@arr).

§

Ticker(TickerEvent)

Full 24-hour ticker for a single symbol.

§

AllTickers(Vec<TickerEvent>)

All-symbol full 24-hour tickers.

§

BookTicker(BookTickerEvent)

Best bid/ask book ticker (detected by "u" key without "e").

§

ForceOrder(ForceOrderEvent)

Liquidation force order event ("e": "forceOrder").

§

AllForceOrders(Vec<ForceOrderEvent>)

All liquidation force orders.

§

PartialDepth(PartialDepthEvent)

Partial depth snapshot (detected by "lastUpdateId" key).

§

DiffDepth(DiffDepthEvent)

Differential depth update ("e": "depthUpdate").

§

Unknown(Value)

Unknown or unrecognised message — captured as raw JSON for forward compatibility.

Trait Implementations§

Source§

impl Debug for WebSocketMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

Source§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more