Struct ProtoMessage 

pub struct ProtoMessage {
    pub payload_type: u32,
    pub payload: Option<Vec<u8>>,
    pub client_msg_id: Option<String>,
}

• Base message that is used for all messages that are sent to/from Open API proxy of cTrader platform.

Fields

payload_type: u32

Contains id of ProtoPayloadType or other custom PayloadTypes (e.g. ProtoOAPayloadType).

payload: Option<Vec<u8>>

Serialized protobuf message that corresponds to payloadType.

client_msg_id: Option<String>

Request message id, assigned by the client that will be returned in the response.

Implementations

impl ProtoMessage

pub fn payload(&self) -> &[u8]

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

pub fn client_msg_id(&self) -> &str

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

Trait Implementations

impl Clone for ProtoMessage

fn clone(&self) -> ProtoMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtoMessage

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

Formats the value using the given formatter.

impl Default for ProtoMessage

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ProtoMessage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ProtoMessage

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 ProtoMessage

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

impl StructuralPartialEq for ProtoMessage