Struct StreamBuilder 

pub struct StreamBuilder<InstrumentKey, Kind>
where
    Kind: SubscriptionKind,
{
    pub channels: HashMap<ExchangeId, Channel<MarketStreamResult<InstrumentKey, Kind::Event>>>,
    pub futures: Vec<SubscribeFuture>,
}

Builder to configure and initialise a Streams<MarketEvent<SubscriptionKind::Event> instance for a specific SubscriptionKind.

Fields

channels: HashMap<ExchangeId, Channel<MarketStreamResult<InstrumentKey, Kind::Event>>>

futures: Vec<SubscribeFuture>

Implementations

impl<InstrumentKey, Kind> StreamBuilder<InstrumentKey, Kind>

where Kind: SubscriptionKind,

pub fn new() -> Self

Construct a new Self.

pub fn subscribe<SubIter, Sub, Exchange, Instrument>( self, subscriber: Exchange::Subscriber, subscriptions: SubIter, ) -> Self

where SubIter: IntoIterator<Item = Sub>, Sub: Into<Subscription<Exchange, Instrument, Kind>>, Exchange: StreamSelector<Instrument, Kind> + Ord + Send + Sync + 'static, Instrument: InstrumentData<Key = InstrumentKey> + Ord + Display + 'static, Instrument::Key: Debug + Clone + Send + 'static, Kind: Ord + Display + Send + Sync + 'static, Kind::Event: Clone + Send, Subscription<Exchange, Instrument, Kind>: Identifier<Exchange::Channel> + Identifier<Exchange::Market>,

Add a collection of Subscriptions to the StreamBuilder that will be actioned on a connection the subscriber provides.

For almost every exchange that is a distinct WebSocket per call. A subscriber whose clones share one connection — for a provider that allows a key a single connection — instead serves each call over a view of it; see Subscriber::Transport.

The subscriber handles the connection and authentication. For unauthenticated exchanges, use WebSocketSubscriber. For authenticated exchanges like Alpaca, use the exchange-specific subscriber with credentials.

Note that Subscriptions are not actioned until the init() method is invoked.

pub async fn init( self, ) -> Result<Streams<MarketStreamResult<InstrumentKey, Kind::Event>>, DataError>

Spawn a MarketStreamResult<SubscriptionKind::Event> consumer loop for each collection of Subscriptions added to StreamBuilder via the subscribe() method.

Each consumer loop distributes consumed MarketStreamResult to the Streams HashMap returned by this method.

Trait Implementations

impl<InstrumentKey, Kind> Debug for StreamBuilder<InstrumentKey, Kind>

where InstrumentKey: Debug, Kind: SubscriptionKind,

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

Formats the value using the given formatter.

impl<InstrumentKey: Default, Kind> Default for StreamBuilder<InstrumentKey, Kind>

where Kind: SubscriptionKind + Default, Kind::Event: Default,

fn default() -> Self

Returns the “default value” for a type.