Skip to main content

OrderRequest

Struct OrderRequest

pub struct OrderRequest {
    pub market: Market,
    pub side: Side,
    pub order_type: OrderType,
    pub size: Size,
    pub price: Option<Decimal>,
    pub time_in_force: Option<TimeInForce>,
    pub reduce_only: bool,
    pub client_id: Option<String>,
}

Expand description

An order to place.

Build it with OrderRequest::market, OrderRequest::limit, or OrderRequest::best, which keep price and size in step. Only a limit order carries a caller-selected price.

Fields§

§market: Market

The market to trade.

§side: Side

Buy or sell.

§order_type: OrderType

Market, limit, or exchange-priced best.

§size: Size

How much, in base or quote terms.

§price: Option<Decimal>

The limit price. None for market and best orders.

§time_in_force: Option<TimeInForce>

How long the order stays live. None leaves it to the exchange default.

§reduce_only: bool

Whether the order may only reduce an existing position.

Derivatives only. Set it with OrderRequest::reduce_only.

§client_id: Option<String>

Caller-assigned order identifier, when the exchange supports one.

Implementations§

impl OrderRequest

pub fn market(market: Market, side: Side, size: Size) -> Self

An order that takes whatever the book offers, immediately.

pub fn limit(market: Market, side: Side, size: Size, price: Decimal) -> Self

An order that rests on the book at a stated price.

pub fn best( market: Market, side: Side, size: Size, time_in_force: TimeInForce, ) -> Self

An order priced from the best opposing quote at submission time.

Exchanges that support this shape require immediate-or-cancel or fill-or-kill. The accepted size unit is exchange-specific.

pub fn time_in_force(self, time_in_force: TimeInForce) -> Self

Sets how long the order stays live.

pub fn reduce_only(self) -> Self

Restricts the order to reducing an existing position.

Rejected as Error::Unsupported on spot markets, which have no positions to reduce.

pub fn client_id(self, client_id: impl Into<String>) -> Self

Sets the caller-assigned order identifier.

Trait Implementations§

impl Clone for OrderRequest

fn clone(&self) -> OrderRequest

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

impl Debug for OrderRequest

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

Formats the value using the given formatter. Read more

impl Eq for OrderRequest

impl PartialEq for OrderRequest

fn eq(&self, other: &OrderRequest) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for OrderRequest

Auto Trait Implementations§

impl Freeze for OrderRequest

impl RefUnwindSafe for OrderRequest

impl Send for OrderRequest

impl Sync for OrderRequest

impl Unpin for OrderRequest

impl UnsafeUnpin for OrderRequest

impl UnwindSafe for OrderRequest

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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