Crate barter_data

source · [−]

Modules

builder

Initialises MarketStreams for an arbitrary number of exchanges using generic Barter Subscriptions.

exchange

Contains Subscriber & ExchangeMapper implementations for specific exchanges.

model

! # Barter-Data Core data structures to support consuming MarketStreams.

test_util

Test utilities for conveniently generating public MarketEvent types.

Enums

ExchangeId

Used to uniquely identify an ExchangeTransformer implementation. Each variant represents an exchange server which can be subscribed to. Note that an exchange may have multiple servers (eg/ binance, binance_futures), therefore there could be a many-to-one relationship between an ExchangeId and an Exchange.

Traits

ExchangeTransformer

defines how to translate between exchange specific data structures & Barter data structures. This must be implemented when integrating a new exchange.

Identifiable

Identifiable structures are capable of determining their associated SubscriptionId. Used by ExchangeTransformer implementations to determine the original Barter Subscription associated with an incoming exchange message.

MarketStream

[Stream] supertrait for streams that yield MarketEvents. Provides an entry-point abstraction for an ExchangeSocket.

Subscriber

Trait that defines how a subscriber will establish a WebSocket connection with an exchange, and action Subscriptions. This must be implemented when integrating a new exchange.

Validator

Validators are capable of determining if their internal state is satisfactory to fulfill some use case defined by the implementor.

Type Definitions

ExchangeWebSocket

Convenient type alias for an ExchangeSocket utilising a tungstenite WebSocket