Struct WsStream 

pub struct WsStream { /* private fields */ }

A Stream wrapper for WebSocket messages.

This struct wraps an mpsc::UnboundedReceiver<WsMessage> and implements the Stream trait, enabling use of stream combinators.

Implementations

impl WsStream

pub fn new(receiver: UnboundedReceiver<WsMessage>) -> Self

Create a new WsStream from an unbounded receiver.

pub fn orderbooks( self, ) -> impl Stream<Item = Box<WsStreamMessage<OrderbookData>>>

Create a filtered stream that only yields orderbook messages.

pub fn trades(self) -> impl Stream<Item = Box<WsStreamMessage<Vec<TradeData>>>>

Create a filtered stream that only yields trade messages.

pub fn tickers(self) -> impl Stream<Item = Box<WsStreamMessage<TickerData>>>

Create a filtered stream that only yields ticker messages.

pub fn klines(self) -> impl Stream<Item = Box<WsStreamMessage<Vec<KlineData>>>>

Create a filtered stream that only yields kline messages.

pub fn liquidations( self, ) -> impl Stream<Item = Box<WsStreamMessage<LiquidationData>>>

Create a filtered stream that only yields liquidation messages.

pub fn operation_responses(self) -> impl Stream<Item = WsOperationResponse>

Create a filtered stream that only yields operation responses.

pub fn positions( self, ) -> impl Stream<Item = Box<WsPrivateMessage<Vec<PositionData>>>>

Create a filtered stream that only yields position updates (private stream).

pub fn orders(self) -> impl Stream<Item = Box<WsPrivateMessage<Vec<OrderData>>>>

Create a filtered stream that only yields order updates (private stream).

pub fn executions( self, ) -> impl Stream<Item = Box<WsPrivateMessage<Vec<ExecutionData>>>>

Create a filtered stream that only yields execution updates (private stream).

pub fn executions_fast( self, ) -> impl Stream<Item = Box<WsPrivateMessage<Vec<ExecutionFastData>>>>

Create a filtered stream that only yields fast execution updates (private stream).

pub fn wallets( self, ) -> impl Stream<Item = Box<WsPrivateMessage<Vec<WalletData>>>>

Create a filtered stream that only yields wallet updates (private stream).

pub fn greeks( self, ) -> impl Stream<Item = Box<WsPrivateMessage<Vec<GreeksData>>>>

Create a filtered stream that only yields greeks updates (private stream, options).

pub fn for_symbol( self, symbol: impl Into<String>, ) -> impl Stream<Item = WsMessage>

Filter messages for a specific symbol.

This filters orderbook, trade, ticker, kline, and liquidation messages that match the given symbol.

pub fn for_topic_prefix( self, prefix: impl Into<String>, ) -> impl Stream<Item = WsMessage>

Filter messages by topic prefix.

This filters stream messages that have a topic starting with the given prefix.

Trait Implementations

impl Stream for WsStream

type Item = WsMessage

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.