Trait barter_data::Subscriber

pub trait Subscriber {
    type SubResponse: Validator + DeserializeOwned;

    fn base_url() -> &'static str;
    fn build_subscription_meta(
        subscriptions: &[Subscription]
    ) -> Result<SubscriptionMeta, SocketError>;

    fn subscribe<'life0, 'async_trait>(
        subscriptions: &'life0 [Subscription]
    ) -> Pin<Box<dyn Future<Output = Result<(WebSocket, SubscriptionIds), SocketError>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: Send + 'async_trait,
    { ... }
    fn validate<'life0, 'async_trait>(
        ids: SubscriptionIds,
        websocket: &'life0 mut WebSocket,
        expected_responses: usize
    ) -> Pin<Box<dyn Future<Output = Result<SubscriptionIds, SocketError>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: Send + 'async_trait,
    { ... }
    fn subscription_timeout() -> Duration { ... }
}

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.

Required Associated Types

type SubResponse: Validator + DeserializeOwned

Deserialisable type that this Subscriber expects to receive from the exchange in response to Subscription requests. Implements Validator in order to determine if the SubResponse communicates a successful outcome.

Required Methods

fn base_url() -> &'static str

Returns the Base URL of the exchange to establish a connection with.

fn build_subscription_meta(
    subscriptions: &[Subscription]
) -> Result<SubscriptionMeta, SocketError>

Uses the provided Barter Subscriptions to build exchange specific subscription payloads. Generates a SubscriptionIds Hashmap that is used by an ExchangeTransformer to identify the Barter Subscriptions associated with received messages.

Provided Methods

fn subscribe<'life0, 'async_trait>(
    subscriptions: &'life0 [Subscription]
) -> Pin<Box<dyn Future<Output = Result<(WebSocket, SubscriptionIds), SocketError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: Send + 'async_trait,

Initialises a WebSocket connection, actions the provided collection of Barter Subscriptions, and validates that the Subscription were accepted by the exchange.

fn validate<'life0, 'async_trait>(
    ids: SubscriptionIds,
    websocket: &'life0 mut WebSocket,
    expected_responses: usize
) -> Pin<Box<dyn Future<Output = Result<SubscriptionIds, SocketError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: Send + 'async_trait,

Uses the provided WebSocket connection to consume Subscription responses and validate their outcomes.

fn subscription_timeout() -> Duration

Return the expected Duration in which the exchange will respond to all actioned WebSocket Subscription requests.

Default: 10 seconds

Implementors

impl Subscriber for BinanceFuturesUsd

type SubResponse = BinanceSubResponse

impl Subscriber for Coinbase

type SubResponse = CoinbaseSubResponse

impl Subscriber for Ftx

type SubResponse = FtxSubResponse

impl Subscriber for Kraken

type SubResponse = KrakenSubResponse