pub struct StreamerClient { /* private fields */ }Expand description
Streaming client for IG Markets real-time data.
This client manages two Lightstreamer connections for different data types:
- Market streamer: Handles market data (prices, market state), trade updates (CONFIRMS, OPU, WOU), and account updates (positions, orders, balance). Uses the default adapter.
- Price streamer: Handles detailed price data (bid/ask levels, sizes, multiple currencies). Uses the “Pricing” adapter.
Each connection type can be managed independently and runs in parallel.
Implementations§
Source§impl StreamerClient
impl StreamerClient
Sourcepub async fn new() -> Result<Self, AppError>
pub async fn new() -> Result<Self, AppError>
Creates a new streaming client instance.
This initializes both streaming clients (market and price) but does not
establish connections yet. Connections are established when connect() is called.
§Returns
Returns a new StreamerClient instance or an error if initialization fails.
Sourcepub async fn market_subscribe(
&mut self,
epics: Vec<String>,
fields: HashSet<StreamingMarketField>,
) -> Result<UnboundedReceiver<PriceData>, AppError>
pub async fn market_subscribe( &mut self, epics: Vec<String>, fields: HashSet<StreamingMarketField>, ) -> Result<UnboundedReceiver<PriceData>, AppError>
Subscribes to market data updates for the specified instruments.
This method creates a subscription to receive real-time market data updates for the given EPICs and returns a channel receiver for consuming the updates.
§Arguments
epics- List of instrument EPICs to subscribe tofields- Set of market data fields to receive (e.g., BID, OFFER, etc.)
§Returns
Returns a receiver channel for PriceData updates, or an error if
the subscription setup failed.
§Examples
let mut receiver = client.market_subscribe(
vec!["IX.D.DAX.DAILY.IP".to_string()],
fields
).await?;
tokio::spawn(async move {
while let Some(price_data) = receiver.recv().await {
println!("Price update: {:?}", price_data);
}
});Sourcepub async fn trade_subscribe(
&mut self,
) -> Result<UnboundedReceiver<TradeFields>, AppError>
pub async fn trade_subscribe( &mut self, ) -> Result<UnboundedReceiver<TradeFields>, AppError>
Subscribes to trade updates for the account.
This method creates a subscription to receive real-time trade confirmations, order updates (OPU), and working order updates (WOU) for the account, and returns a channel receiver for consuming the updates.
§Returns
Returns a receiver channel for TradeFields updates, or an error if
the subscription setup failed.
§Examples
let mut receiver = client.trade_subscribe().await?;
tokio::spawn(async move {
while let Some(trade_fields) = receiver.recv().await {
println!("Trade update: {:?}", trade_fields);
}
});Sourcepub async fn account_subscribe(
&mut self,
fields: HashSet<StreamingAccountDataField>,
) -> Result<UnboundedReceiver<AccountFields>, AppError>
pub async fn account_subscribe( &mut self, fields: HashSet<StreamingAccountDataField>, ) -> Result<UnboundedReceiver<AccountFields>, AppError>
Subscribes to account data updates.
This method creates a subscription to receive real-time account updates including profit/loss, margin, equity, available funds, and other account metrics, and returns a channel receiver for consuming the updates.
§Arguments
fields- Set of account data fields to receive (e.g., PNL, MARGIN, EQUITY, etc.)
§Returns
Returns a receiver channel for AccountFields updates, or an error if
the subscription setup failed.
§Examples
let mut receiver = client.account_subscribe(fields).await?;
tokio::spawn(async move {
while let Some(account_fields) = receiver.recv().await {
println!("Account update: {:?}", account_fields);
}
});Sourcepub async fn price_subscribe(
&mut self,
epics: Vec<String>,
fields: HashSet<StreamingPriceField>,
) -> Result<UnboundedReceiver<PriceData>, AppError>
pub async fn price_subscribe( &mut self, epics: Vec<String>, fields: HashSet<StreamingPriceField>, ) -> Result<UnboundedReceiver<PriceData>, AppError>
Subscribes to price data updates for the specified instruments.
This method creates a subscription to receive real-time price updates including bid/ask prices, sizes, and multiple currency levels for the given EPICs, and returns a channel receiver for consuming the updates.
§Arguments
epics- List of instrument EPICs to subscribe tofields- Set of price data fields to receive (e.g., BID_PRICE1, ASK_PRICE1, etc.)
§Returns
Returns a receiver channel for PriceData updates, or an error if
the subscription setup failed.
§Examples
let mut receiver = client.price_subscribe(
vec!["IX.D.DAX.DAILY.IP".to_string()],
fields
).await?;
tokio::spawn(async move {
while let Some(price_data) = receiver.recv().await {
println!("Price update: {:?}", price_data);
}
});Sourcepub async fn chart_subscribe(
&mut self,
epics: Vec<String>,
scale: ChartScale,
fields: HashSet<StreamingChartField>,
) -> Result<UnboundedReceiver<ChartData>, AppError>
pub async fn chart_subscribe( &mut self, epics: Vec<String>, scale: ChartScale, fields: HashSet<StreamingChartField>, ) -> Result<UnboundedReceiver<ChartData>, AppError>
Subscribes to chart data updates for the specified instruments and scale.
This method creates a subscription to receive real-time chart updates including OHLC data, volume, and other chart metrics for the given EPICs and chart scale, and returns a channel receiver for consuming the updates.
§Arguments
epics- List of instrument EPICs to subscribe to.scale- Chart scale (e.g., Tick, 1Min, 5Min, etc.).fields- Set of chart data fields to receive (e.g., OPEN, HIGH, LOW, CLOSE, VOLUME).
§Returns
Returns a receiver channel for ChartData updates, or an error if
the subscription setup failed.
§Examples
let mut receiver = client.chart_subscribe(
vec!["IX.D.DAX.DAILY.IP".to_string()],
ChartScale::OneMin,
fields
).await?;
tokio::spawn(async move {
while let Some(chart_data) = receiver.recv().await {
println!("Chart update: {:?}", chart_data);
}
});Sourcepub async fn connect(
&mut self,
shutdown_signal: Option<Arc<Notify>>,
) -> Result<(), AppError>
pub async fn connect( &mut self, shutdown_signal: Option<Arc<Notify>>, ) -> Result<(), AppError>
Connects all active Lightstreamer clients and maintains the connections.
This method establishes connections for all streaming clients that have active subscriptions (market and price). Each client runs in its own task and all connections are maintained until a shutdown signal is received.
§Arguments
shutdown_signal- Optional signal to gracefully shutdown all connections. If None, a default signal handler for SIGINT/SIGTERM will be created.
§Returns
Returns Ok(()) when all connections are closed gracefully, or an error if
any connection fails after maximum retry attempts.
Auto Trait Implementations§
impl Freeze for StreamerClient
impl !RefUnwindSafe for StreamerClient
impl Send for StreamerClient
impl Sync for StreamerClient
impl Unpin for StreamerClient
impl !UnwindSafe for StreamerClient
Blanket Implementations§
§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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