Struct ProtoOaSpotEvent 

pub struct ProtoOaSpotEvent {
    pub payload_type: Option<i32>,
    pub ctid_trader_account_id: i64,
    pub symbol_id: i64,
    pub bid: Option<u64>,
    pub ask: Option<u64>,
    pub trendbar: Vec<ProtoOaTrendbar>,
    pub session_close: Option<u64>,
    pub timestamp: Option<i64>,
}

• Event that is sent when a new spot event is generated on the server side. Requires subscription on the spot events, see ProtoOASubscribeSpotsReq. First event, received after subscription will contain latest spot prices even if market is closed.

Fields

payload_type: Option<i32>

ctid_trader_account_id: i64

Unique identifier of the trader’s account. Used to match responses to trader’s accounts.

symbol_id: i64

Unique identifier of the Symbol in cTrader platform.

bid: Option<u64>

Bid price. Specified in 1/100000 of unit of a price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782)

ask: Option<u64>

Ask price. Specified in 1/100000 of unit of a price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782)

trendbar: Vec<ProtoOaTrendbar>

Returns live trend bar. Requires subscription on the trend bars.

session_close: Option<u64>

Last session close. Specified in 1/100000 of unit of a price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782)

timestamp: Option<i64>

The Unix time for spot.

Implementations

impl ProtoOaSpotEvent

pub fn payload_type(&self) -> ProtoOaPayloadType

Returns the enum value of payload_type, or the default if the field is unset or set to an invalid enum value.

pub fn set_payload_type(&mut self, value: ProtoOaPayloadType)

Sets payload_type to the provided enum value.

pub fn bid(&self) -> u64

Returns the value of bid, or the default value if bid is unset.

pub fn ask(&self) -> u64

Returns the value of ask, or the default value if ask is unset.

pub fn session_close(&self) -> u64

Returns the value of session_close, or the default value if session_close is unset.

pub fn timestamp(&self) -> i64

Returns the value of timestamp, or the default value if timestamp is unset.

Trait Implementations

impl Clone for ProtoOaSpotEvent

fn clone(&self) -> ProtoOaSpotEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtoOaSpotEvent

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

Formats the value using the given formatter.

impl Default for ProtoOaSpotEvent

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProtoOaSpotEvent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProtoOaSpotEvent

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