Struct barter_data::streams::builder::StreamBuilder

pub struct StreamBuilder<Kind>where
    Kind: SubKind,{
    pub channels: HashMap<ExchangeId, ExchangeChannel<Kind>>,
    pub futures: Vec<SubscribeFuture>,
    /* private fields */
}

Builder to configure and initialise Streams instances for a specific SubKind.

Fields

channels: HashMap<ExchangeId, ExchangeChannel<Kind>>

futures: Vec<SubscribeFuture>

Implementations

impl<Kind> StreamBuilder<Kind>where
    Kind: SubKind,

pub fn new() -> Self

Construct a new Self.

pub fn subscribe<SubIter, Sub, Exchange>(self, subscriptions: SubIter) -> Selfwhere
    SubIter: IntoIterator<Item = Sub>,
    Sub: Into<Subscription<Exchange, Kind>>,
    Exchange: StreamSelector<Kind> + Ord + Send + Sync + 'static,
    Kind: Ord + Send + Sync + 'static,
    Kind::Event: Send,
    Subscription<Exchange, Kind>: Identifier<Exchange::Channel> + Identifier<Exchange::Market>,

Add a collection of Subscriptions to the StreamBuilder that will be initialised on a distinct WebSocket connection.

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

pub async fn init(self) -> Result<Streams<Kind>, DataError>

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

Each consumer loop distributes consumed Market<Event>s to the Streams HashMap returned by this method.

Trait Implementations

impl<Kind> Debug for StreamBuilder<Kind>where
    Kind: SubKind,

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

Formats the value using the given formatter.

impl<Kind> Default for StreamBuilder<Kind>where
    Kind: SubKind + Default,

fn default() -> StreamBuilder<Kind>

Returns the “default value” for a type.