Struct alpaca_finance::Streamer

pub struct Streamer<'a> { /* fields omitted */ }

Realtime event streamer

Currently streams updates to orders and the account. To use the streamer, first create a new one and then listen on the stream of events coming in.

Example

To listen on the stream of events:

let alpaca = Alpaca::live("KEY_ID", "SECRET").await.unwrap();

let streamer = Streamer:new(&alpaca);
streamer.start().await
   .for_each(|msg| {
      match msg {
         StreamMessage::Account(_) => println!("Got an account update!"),
         StreamMessage::Order(_) => println!("Got an order update!"),
         _ => println!("Got an unexpected msg")
      }
      future::ready(())
   })
   .await;

Implementations

impl<'a> Streamer<'a>

pub fn new(alpaca: &'a Alpaca) -> Streamer<'a>

Creates a new event streamer.

pub async fn start<'_>(&'_ self) -> impl Stream<Item = StreamMessage>

Starts the stream of events

pub fn stop(&mut self)

Stops the stream of events