Struct kucoin_rs::kucoin::trade::OrderOptionals

pub struct OrderOptionals<'a> {
    pub remark: Option<&'a str>,
    pub stop: Option<&'a str>,
    pub stop_price: Option<&'a str>,
    pub stp: Option<&'a str>,
    pub trade_type: Option<&'a str>,
    pub time_in_force: Option<&'a str>,
    pub cancel_after: Option<i64>,
    pub post_only: Option<bool>,
    pub hidden: Option<bool>,
    pub iceberg: Option<bool>,
    pub visible_size: Option<&'a str>,
}

OrderOptionals contains a builder pattern that can be used to more easily take advantage of optional inputs.

Example:

use kucoin_rs::kucoin::trade::OrderOptionals; 

    let options = OrderOptionals::new()
        .remark("Example of OrderOptionals builder pattern")
        .stp("CO")
        .hidden(true)
        .build();

See the Kucoin documentation for full list of options relative to market and limit orders.

Fields

remark: Option<&'a str>

stop: Option<&'a str>

stop_price: Option<&'a str>

stp: Option<&'a str>

trade_type: Option<&'a str>

time_in_force: Option<&'a str>

cancel_after: Option<i64>

post_only: Option<bool>

hidden: Option<bool>

iceberg: Option<bool>

visible_size: Option<&'a str>

Implementations

impl<'a> OrderOptionals<'a>

Generates new empty OrderOptionals struct ready for building.

pub fn new() -> Self

pub fn remark(&mut self, r: &'a str) -> &mut Self

pub fn stop(&mut self, s: &'a str) -> &mut Self

pub fn stop_price(&mut self, s: &'a str) -> &mut Self

pub fn stp(&mut self, s: &'a str) -> &mut Self

pub fn time_in_force(&mut self, t: &'a str) -> &mut Self

pub fn trade_type(&mut self, t: &'a str) -> &mut Self

pub fn cancel_after(&mut self, c: i64) -> &mut Self

pub fn post_only(&mut self, p: bool) -> &mut Self

pub fn hidden(&mut self, h: bool) -> &mut Self

pub fn iceberg(&mut self, i: bool) -> &mut Self

pub fn visible_size(&mut self, v: &'a str) -> &mut Self

pub fn build(&self) -> Self

Builds an OrderOptional Type from chained optional funtions to be used with posting orders. Only contains optional inputs the post order functions require specific required inputs. See those functions' documentation for details.

Trait Implementations

impl<'a> Clone for OrderOptionals<'a>

fn clone(&self) -> OrderOptionals<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OrderOptionals<'a>

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

Formats the value using the given formatter.

impl<'a> Default for OrderOptionals<'a>

fn default() -> OrderOptionals<'a>

Returns the "default value" for a type.

impl<'a> PartialEq<OrderOptionals<'a>> for OrderOptionals<'a>

fn eq(&self, other: &OrderOptionals<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OrderOptionals<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for OrderOptionals<'a>