Skip to main content

OrderTestParams

Struct OrderTestParams 

Source
pub struct OrderTestParams {
Show 21 fields pub symbol: String, pub side: OrderTestSideEnum, pub type: OrderTestTypeEnum, pub id: Option<String>, pub compute_commission_rates: Option<bool>, pub time_in_force: Option<OrderTestTimeInForceEnum>, pub price: Option<Decimal>, pub quantity: Option<Decimal>, pub quote_order_qty: Option<Decimal>, pub new_client_order_id: Option<String>, pub new_order_resp_type: Option<OrderTestNewOrderRespTypeEnum>, pub stop_price: Option<Decimal>, pub trailing_delta: Option<i32>, pub iceberg_qty: Option<Decimal>, pub strategy_id: Option<i64>, pub strategy_type: Option<i32>, pub self_trade_prevention_mode: Option<OrderTestSelfTradePreventionModeEnum>, pub peg_price_type: Option<OrderTestPegPriceTypeEnum>, pub peg_offset_value: Option<i32>, pub peg_offset_type: Option<OrderTestPegOffsetTypeEnum>, pub recv_window: Option<Decimal>,
}
Expand description

Request parameters for the [order_test] operation.

This struct holds all of the inputs you can pass when calling order_test.

Fields§

§symbol: String

The symbol parameter.

This field is **required.

§side: OrderTestSideEnum

The side parameter.

This field is **required.

§type: OrderTestTypeEnum

The r#type parameter.

This field is **required.

§id: Option<String>

Unique WebSocket request ID.

This field is **optional.

§compute_commission_rates: Option<bool>

Default: false
See Commissions FAQ to learn more.

This field is **optional.

§time_in_force: Option<OrderTestTimeInForceEnum>

The time_in_force parameter.

This field is **optional.

§price: Option<Decimal>

The price parameter.

This field is **optional.

§quantity: Option<Decimal>

The quantity parameter.

This field is **optional.

§quote_order_qty: Option<Decimal>

The quote_order_qty parameter.

This field is **optional.

§new_client_order_id: Option<String>

The new client order ID for the order after being amended.
If not sent, one will be randomly generated.
It is possible to reuse the current clientOrderId by sending it as the newClientOrderId.

This field is **optional.

§new_order_resp_type: Option<OrderTestNewOrderRespTypeEnum>

The new_order_resp_type parameter.

This field is **optional.

§stop_price: Option<Decimal>

The stop_price parameter.

This field is **optional.

§trailing_delta: Option<i32>

See Trailing Stop order FAQ

This field is **optional.

§iceberg_qty: Option<Decimal>

The iceberg_qty parameter.

This field is **optional.

§strategy_id: Option<i64>

Arbitrary numeric value identifying the order within an order strategy.

This field is **optional.

§strategy_type: Option<i32>

Arbitrary numeric value identifying the order strategy. Values smaller than 1000000 are reserved and cannot be used.

This field is **optional.

§self_trade_prevention_mode: Option<OrderTestSelfTradePreventionModeEnum>

The self_trade_prevention_mode parameter.

This field is **optional.

§peg_price_type: Option<OrderTestPegPriceTypeEnum>

The peg_price_type parameter.

This field is **optional.

§peg_offset_value: Option<i32>

Price level to peg the price to (max: 100) See Pegged Orders

This field is **optional.

§peg_offset_type: Option<OrderTestPegOffsetTypeEnum>

The peg_offset_type parameter.

This field is **optional.

§recv_window: Option<Decimal>

The value cannot be greater than 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.

This field is **optional.

Implementations§

Source§

impl OrderTestParams

Source

pub fn builder( symbol: String, side: OrderTestSideEnum, type: OrderTestTypeEnum, ) -> OrderTestParamsBuilder

Create a builder for [order_test].

Required parameters:

  • symbol — String
  • side — String
  • r#type — String

Trait Implementations§

Source§

impl Clone for OrderTestParams

Source§

fn clone(&self) -> OrderTestParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OrderTestParams

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more