Struct Order 

pub struct Order {

    pub order_id: Option<OrderId>,
    pub side: i32,
    pub quantums: u64,
    pub subticks: u64,
    pub time_in_force: i32,
    pub reduce_only: bool,
    pub client_metadata: u32,
    pub condition_type: i32,
    pub conditional_order_trigger_subticks: u64,
    pub twap_parameters: Option<TwapParameters>,
    pub builder_code_parameters: Option<BuilderCodeParameters>,
    pub order_router_address: String,
    pub good_til_oneof: Option<GoodTilOneof>,
}

Order represents a single order belonging to a Subaccount for a particular ClobPair.

Fields

order_id: Option<OrderId>

The unique ID of this order. Meant to be unique across all orders.

side: i32

quantums: u64

The size of this order in base quantums. Must be a multiple of ClobPair.StepBaseQuantums (where ClobPair.Id = orderId.ClobPairId).

subticks: u64

The price level that this order will be placed at on the orderbook, in subticks. Must be a multiple of ClobPair.SubticksPerTick (where ClobPair.Id = orderId.ClobPairId).

time_in_force: i32

The time in force of this order.

reduce_only: bool

Enforces that the order can only reduce the size of an existing position. If a ReduceOnly order would change the side of the existing position, its size is reduced to that of the remaining size of the position. If existing orders on the book with ReduceOnly would already close the position, the least aggressive (out-of-the-money) ReduceOnly orders are resized and canceled first.

client_metadata: u32

Set of bit flags set arbitrarily by clients and ignored by the protocol. Used by indexer to infer information about a placed order.

condition_type: i32

conditional_order_trigger_subticks: u64

conditional_order_trigger_subticks represents the price at which this order will be triggered. If the condition_type is CONDITION_TYPE_UNSPECIFIED, this value is enforced to be 0. If this value is nonzero, condition_type cannot be CONDITION_TYPE_UNSPECIFIED. Value is in subticks. Must be a multiple of ClobPair.SubticksPerTick (where ClobPair.Id = orderId.ClobPairId).

twap_parameters: Option<TwapParameters>

twap_parameters represent the configuration for a TWAP order. This must be set for twap orders and will be ignored for all other order types.

builder_code_parameters: Option<BuilderCodeParameters>

builder_code_parameters is the metadata for the partner or builder of an order specifying the fees charged.

order_router_address: String

order_router_address is the address of the order router that placed the order.

good_til_oneof: Option<GoodTilOneof>

Information about when the order expires.

Implementations

impl Order

pub fn side(&self) -> Side

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

pub fn set_side(&mut self, value: Side)

Sets side to the provided enum value.

pub fn time_in_force(&self) -> TimeInForce

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

pub fn set_time_in_force(&mut self, value: TimeInForce)

Sets time_in_force to the provided enum value.

pub fn condition_type(&self) -> ConditionType

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

pub fn set_condition_type(&mut self, value: ConditionType)

Sets condition_type to the provided enum value.

Trait Implementations

impl Clone for Order

fn clone(&self) -> Order

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Order

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

Formats the value using the given formatter.

impl Default for Order

fn default() -> Order

Returns the “default value” for a type.

impl Message for Order

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 Name for Order

const NAME: &'static str = "Order"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "dydxprotocol.clob"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for Order

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