Struct ProtoOaErrorRes 

pub struct ProtoOaErrorRes {
    pub payload_type: Option<i32>,
    pub ctid_trader_account_id: Option<i64>,
    pub error_code: String,
    pub description: Option<String>,
    pub maintenance_end_timestamp: Option<i64>,
    pub retry_after: Option<u64>,
}

• Generic response when an ERROR occurred.

Fields

payload_type: Option<i32>

ctid_trader_account_id: Option<i64>

The unique identifier of the trader’s account in cTrader platform.

error_code: String

The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode).

description: Option<String>

The error description.

maintenance_end_timestamp: Option<i64>

The Unix time in seconds when the current maintenance session will be ended.

retry_after: Option<u64>

When you hit rate limit with errorCode=BLOCKED_PAYLOAD_TYPE, this field will contain amount of seconds until related payload type will be unlocked.

Implementations

impl ProtoOaErrorRes

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 ctid_trader_account_id(&self) -> i64

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

pub fn description(&self) -> &str

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

pub fn maintenance_end_timestamp(&self) -> i64

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

pub fn retry_after(&self) -> u64

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

Trait Implementations

impl Clone for ProtoOaErrorRes

fn clone(&self) -> ProtoOaErrorRes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtoOaErrorRes

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

Formats the value using the given formatter.

impl Default for ProtoOaErrorRes

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ProtoOaErrorRes

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 ProtoOaErrorRes

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 ProtoOaErrorRes

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

impl StructuralPartialEq for ProtoOaErrorRes