Enum BcsWsChannel 

pub enum BcsWsChannel {
    Limits,
    Portfolio,
    MarketData,
    OrderExecution,
    OrderTransaction,
    OrderEvents,
    MarginalIndicators,
}

A WebSocket channel (service) of the BCS API. Each channel is its own URL and its own connection.

Only BcsWsChannel::MarketData takes subscription commands. The others push their data as soon as they are connected, with nothing to send.

The broker limits the number of simultaneous connections per account: 2 for portfolio, limits and margin indicators, 4 for orders, 20 for market data (broker docs). It also limits the client to 10 messages per second and 100 instruments per connection.

Examples

use brokapi_bcs_protocol::ws::client::BcsWsChannel;

let channel: BcsWsChannel = serde_json::from_str("\"market_data\"")?;
assert_eq!(channel, BcsWsChannel::MarketData);

Variants

Limits

Account limits: positions, money, futures limits (limits/ws). Parsed into IncomingMessage::Limits.

Portfolio

Portfolio positions with values and P/L (portfolio/ws). Parsed into IncomingMessage::Portfolio.

MarketData

Market data: quotes, order book, trades tape and last candle (market-data/ws). The only channel that takes subscriptions. Parsed into IncomingMessage::MarketData.

OrderExecution

Deprecated order execution channel (orders/execution/ws). The broker docs mark it deprecated: use BcsWsChannel::OrderEvents. Parsed into IncomingMessage::OrderExecution.

OrderTransaction

Deprecated order transaction channel (orders/transaction/ws). The broker docs mark it deprecated: use BcsWsChannel::OrderEvents. Parsed into IncomingMessage::OrderTransaction.

OrderEvents

Current order status channel (orders/events/ws), replaces execution-status and transaction-status, which the docs now mark deprecated. Parsed into IncomingMessage::OrderExecution.

MarginalIndicators

Margin indicators: portfolio value, margin level, debts (marginal-indicators/ws). Parsed into IncomingMessage::MarginalIndicators.

Trait Implementations

impl Clone for BcsWsChannel

fn clone(&self) -> BcsWsChannel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BcsWsChannel

impl Debug for BcsWsChannel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BcsWsChannel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BcsWsChannel

impl PartialEq for BcsWsChannel

fn eq(&self, other: &BcsWsChannel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BcsWsChannel