Struct StreamingClient 

pub struct StreamingClient { /* private fields */ }

Available on crate feature stream only.

A live Lightstreamer session with active subscriptions.

Obtained via StreamingApi::connect or StreamingApi::connect_with. All subscription methods return a tokio::sync::mpsc::Receiver<T>. Dropping the receiver automatically cancels the subscription server-side the next time the server sends an update for that item.

Call StreamingClient::disconnect to cleanly tear down the session.

Implementations

impl StreamingClient

pub async fn subscribe_market( &self, epic: &str, ) -> Result<Receiver<MarketUpdate>>

Subscribe to market price updates for epic.

Returns a Receiver<MarketUpdate>. Each received value is a snapshot of all changed fields merged with the previous state — no field is ever “missing”.

pub async fn subscribe_chart_tick( &self, epic: &str, ) -> Result<Receiver<ChartTickUpdate>>

Subscribe to chart tick data for epic.

Returns a Receiver<ChartTickUpdate>. This is a DISTINCT-mode subscription — every message is a fresh tick, not a merge.

pub async fn subscribe_chart_candle( &self, epic: &str, scale: CandleScale, ) -> Result<Receiver<ChartCandleUpdate>>

Subscribe to OHLC candle data for epic at scale.

Returns a Receiver<ChartCandleUpdate>. This is a MERGE-mode subscription — fields are merged across updates for the current candle.

pub async fn subscribe_account( &self, account_id: &str, ) -> Result<Receiver<AccountUpdate>>

Subscribe to account balance and margin updates.

Returns a Receiver<AccountUpdate>.

pub async fn subscribe_trade( &self, account_id: &str, ) -> Result<Receiver<TradeUpdate>>

Subscribe to trade confirmations and working-order updates.

Returns a Receiver<TradeUpdate>.

pub async fn disconnect(self) -> Result<()>

Disconnect from Lightstreamer and stop the background read-loop task.

After this call all pending Receivers will no longer receive updates.

The method signature is async for forward compatibility (future implementations may need to await a clean shutdown handshake with the server).

pub fn session_id(&self) -> &str

Return the current Lightstreamer session ID.

Trait Implementations

impl Debug for StreamingClient

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

Formats the value using the given formatter.