Skip to main content

PreviewOrderParams

Struct PreviewOrderParams 

Source
pub struct PreviewOrderParams {
Show 15 fields pub symbol: String, pub side: CreateSide, pub order_type: CreateOrderType, pub quantity: Option<Quantity>, pub max_quote_debit_scaled: Option<Quantity>, pub price: Option<Price>, pub time_in_force: Option<CreateTimeInForce>, pub client_order_id: Option<String>, pub subaccount_id: Option<u64>, pub post_only: Option<bool>, pub market_client_ref_price: Option<Price>, pub fee_asset: Option<FeeAsset>, pub self_trade_prevention: Option<OrderSelfTradePrevention>, pub market_max_slippage: Option<MaxSlippage>, pub attached_risk: Option<AttachedRisk>,
}
Expand description

Order inputs accepted by crate::services::OrdersService::preview.

Preview uses the same OrderIntent contract as create. The host performs an admissibility check only: no hold is placed, and client_order_id is accepted but not claimed.

Fields§

§symbol: String§side: CreateSide§order_type: CreateOrderType§quantity: Option<Quantity>

Base quantity. Set exactly one of this and max_quote_debit_scaled.

§max_quote_debit_scaled: Option<Quantity>

Hard all-in quote debit limit. The Quantity must use crate::types::QuantityDomain::OrderQuote and carry the pair’s catalog quote scale. Set exactly one of this and quantity.

§price: Option<Price>§time_in_force: Option<CreateTimeInForce>§client_order_id: Option<String>

Optional client order id. Accepted for shape parity with create; preview does not claim it.

§subaccount_id: Option<u64>§post_only: Option<bool>§market_client_ref_price: Option<Price>§fee_asset: Option<FeeAsset>§self_trade_prevention: Option<OrderSelfTradePrevention>§market_max_slippage: Option<MaxSlippage>§attached_risk: Option<AttachedRisk>

Optional TP/SL/trailing controls. Preview validates the full intent; nothing is armed until a subsequent create.

Trait Implementations§

Source§

impl Clone for PreviewOrderParams

Source§

fn clone(&self) -> PreviewOrderParams

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 PreviewOrderParams

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> 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