Skip to main content

Order

Struct Order 

Source
pub struct Order {
    pub symbol: Symbol,
    pub side: Side,
    pub kind: OrderKind,
    pub size: Volume,
    pub limit_price: Option<Price>,
    pub reduce_only: bool,
    pub client_id: Option<String>,
    pub stop: Option<StopAttachment>,
}
Expand description

A request to enter, exit, or reduce a position.

This is the framework-level abstraction; concrete exchange adapters translate it into exchange-specific payloads. The client_id is optional but strongly recommended — it lets the framework reconcile fills back to this order.

§Example

use rustrade_core::{Order, Price, Side, StopAttachment, Volume};

// Market order — the everyday case.
let mkt = Order::market("BTCUSDT", Side::Buy, Volume(2.0));
assert_eq!(mkt.symbol.as_str(), "BTCUSDT");

// Limit order with a stop-market attachment.
let limit = Order::limit("ETHUSDT", Side::Sell, Volume(1.0), Price(3_500.0))
    .with_stop(StopAttachment::stop_market(Price(3_400.0)));
assert!(limit.stop.is_some());

Fields§

§symbol: Symbol

Symbol the order is for.

§side: Side

Side of the trade (buy or sell).

§kind: OrderKind

Market / limit / time-in-force variant.

§size: Volume

Quantity in base-asset units or contracts.

§limit_price: Option<Price>

Limit price for non-market orders.

§reduce_only: bool

Set to true for exit orders that must never increase the position.

§client_id: Option<String>

Optional client-supplied id. Exchanges that support it will echo it back on fills, making reconciliation trivial.

§stop: Option<StopAttachment>

Optional stop-order attachment. Adapters that don’t advertise Capability::StopOrders must reject orders carrying this field.

Implementations§

Source§

impl Order

Source

pub fn market(symbol: impl Into<Symbol>, side: Side, size: Volume) -> Order

Construct a market order.

Source

pub fn limit( symbol: impl Into<Symbol>, side: Side, size: Volume, price: Price, ) -> Order

Construct a standard limit order resting at price.

Source

pub fn with_reduce_only(self, reduce_only: bool) -> Order

Set or clear the reduce_only flag.

Source

pub fn with_client_id(self, id: impl Into<String>) -> Order

Set the optional client id used to reconcile fills back to this order.

Source

pub fn with_stop(self, stop: StopAttachment) -> Order

Attach a stop. Adapter must advertise Capability::StopOrders.

Trait Implementations§

Source§

impl Clone for Order

Source§

fn clone(&self) -> Order

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 Order

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Order

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Order, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Order

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Order

§

impl RefUnwindSafe for Order

§

impl Send for Order

§

impl Sync for Order

§

impl Unpin for Order

§

impl UnsafeUnpin for Order

§

impl UnwindSafe for Order

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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