Struct PostOrderParamsBuilder 

pub struct PostOrderParamsBuilder { /* private fields */ }

Builder for PostOrderParams.

Implementations

impl PostOrderParamsBuilder

pub fn symbol<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Instrument symbol. e.g. ‘XBTUSD’.

pub fn side<VALUE: Into<BitmexSide>>(&mut self, value: VALUE) -> &mut Self

Order side. Valid options: Buy, Sell. Defaults to ‘Buy’ unless orderQty is negative.

pub fn order_qty<VALUE: Into<u32>>(&mut self, value: VALUE) -> &mut Self

Order quantity in units of the instrument (i.e. contracts).

pub fn price<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Optional limit price for Limit, StopLimit, and LimitIfTouched orders.

pub fn display_qty<VALUE: Into<u32>>(&mut self, value: VALUE) -> &mut Self

Optional quantity to display in the book. Use 0 for a fully hidden order.

pub fn stop_px<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Optional trigger price for Stop, StopLimit, MarketIfTouched, and LimitIfTouched orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use execInst of MarkPrice or LastPrice to define the current price used for triggering.

pub fn cl_ord_id<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Optional Client Order ID. This clOrdID will come back on the order and any related executions.

pub fn cl_ord_link_id<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Optional Client Order Link ID for contingent orders.

pub fn peg_offset_value<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Optional trailing offset from the current price for Stop, StopLimit, MarketIfTouched, and LimitIfTouched orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for ‘Pegged’ orders.

pub fn peg_price_type<VALUE: Into<BitmexPegPriceType>>( &mut self, value: VALUE, ) -> &mut Self

Optional peg price type. Valid options: LastPeg, MidPricePeg, MarketPeg, PrimaryPeg, TrailingStopPeg.

pub fn ord_type<VALUE: Into<BitmexOrderType>>( &mut self, value: VALUE, ) -> &mut Self

Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, Pegged. Defaults to Limit when price is specified. Defaults to Stop when stopPx is specified. Defaults to StopLimit when price and stopPx are specified.

pub fn time_in_force<VALUE: Into<BitmexTimeInForce>>( &mut self, value: VALUE, ) -> &mut Self

Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to GoodTillCancel for Limit, StopLimit, and LimitIfTouched orders.

pub fn exec_inst<VALUE: Into<Vec<BitmexExecInstruction>>>( &mut self, value: VALUE, ) -> &mut Self

Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed. AllOrNone instruction requires displayQty to be 0. MarkPrice, IndexPrice or LastPrice instruction valid for Stop, StopLimit, MarketIfTouched, and LimitIfTouched orders.

pub fn contingency_type<VALUE: Into<BitmexContingencyType>>( &mut self, value: VALUE, ) -> &mut Self

Deprecated: linked orders are not supported after 2018/11/10.

pub fn text<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Optional order annotation. e.g. ‘Take profit’.

pub fn build(&self) -> Result<PostOrderParams, PostOrderParamsBuilderError>

Builds a new PostOrderParams.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for PostOrderParamsBuilder

fn clone(&self) -> PostOrderParamsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for PostOrderParamsBuilder

fn default() -> Self

Returns the “default value” for a type.