Struct WsSubscribe 

pub struct WsSubscribe {
    pub opcode: String,
    pub guid: String,
    pub params: Map<String, Value>,
}

A subscription request, without the token (the session adds it when it sends).

Build one with the constructors (WsSubscribe::order_book and so on, one per opcode of the broker). The guid is yours: it names the subscription for unsubscribe and marks its data frames.

Examples

use brokapi_alor_protocol::ws::models::WsSubscribe;

let sub = WsSubscribe::order_book("g1", "MOEX", "SBER", Some("TQBR"), 10);
let json: serde_json::Value = serde_json::from_str(&sub.to_json("token")).unwrap();
assert_eq!(json["opcode"], "OrderBookGetAndSubscribe");
assert_eq!(json["guid"], "g1");
assert_eq!(json["token"], "token");
assert_eq!(json["depth"], 10);
assert_eq!(json["format"], "Simple");

Fields

opcode: String

What to subscribe to, in the words of the broker (OrderBookGetAndSubscribe, …).

guid: String

The id of this subscription.

params: Map<String, Value>

The other fields of the request.

Implementations

impl WsSubscribe

pub fn order_book( guid: &str, exchange: &str, code: &str, group: Option<&str>, depth: u32, ) -> Self

The order book of an instrument (OrderBookGetAndSubscribe): a whole book per message, depth levels (20 by default, 50 at most).

pub fn bars( guid: &str, exchange: &str, code: &str, group: Option<&str>, tf: &str, from: i64, skip_history: bool, ) -> Self

Candles of an instrument (BarsGetAndSubscribe). tf is a number of seconds or D, W, M, Y; from (Unix seconds) is the first candle of the history that comes first; skip_history leaves it out.

pub fn quotes( guid: &str, exchange: &str, code: &str, group: Option<&str>, ) -> Self

Quotations of an instrument (QuotesSubscribe).

pub fn all_trades( guid: &str, exchange: &str, code: &str, group: Option<&str>, ) -> Self

All trades of the market in an instrument (AllTradesGetAndSubscribe).

pub fn instruments( guid: &str, exchange: &str, code: &str, group: Option<&str>, ) -> Self

Changes of the instruments of an exchange (InstrumentsGetAndSubscribeV2).

pub fn orders( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

Orders of a portfolio (OrdersGetAndSubscribeV2). Without skip_history the orders of today come first (frames with existing: true), then the changes.

pub fn stop_orders( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

Stop orders of a portfolio (StopOrdersGetAndSubscribeV2).

pub fn trades( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

Trades (fills) of a portfolio (TradesGetAndSubscribeV2).

pub fn positions( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

Positions and money of a portfolio (PositionsGetAndSubscribeV2).

pub fn summaries( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

The summary of a portfolio (SummariesGetAndSubscribeV2).

pub fn risks( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

The risks of a portfolio (RisksGetAndSubscribe).

pub fn spectra_risks( guid: &str, exchange: &str, portfolio: &str, skip_history: bool, ) -> Self

The risks of the futures market of a portfolio (SpectraRisksGetAndSubscribe).

pub fn unsubscribe(guid: &str) -> Self

The request that cancels the subscription named by guid (unsubscribe). It is sent in the connection the subscription lives in.

pub fn to_json(&self, token: &str) -> String

The JSON text of the request with token written into it.

pub fn is_unsubscribe(&self) -> bool

true for the request that cancels a subscription.

Trait Implementations

impl Clone for WsSubscribe

fn clone(&self) -> WsSubscribe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsSubscribe

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

Formats the value using the given formatter.

impl PartialEq for WsSubscribe

fn eq(&self, other: &WsSubscribe) -> 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 Serialize for WsSubscribe

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WsSubscribe