Skip to main content

OrderAmendment

Struct OrderAmendment 

Source
pub struct OrderAmendment { /* private fields */ }
Expand description

Change to a pending order.

The amendment starts from the order as it was read and carries every value the request can state, changed or not, so the order ends up exactly as the amendment describes it: a stop loss, a take profit or an expiry the amendment does not hold is taken off the order.

Implementations§

Source§

impl OrderAmendment

Source

pub fn of(account: AccountId, order: &Order) -> Self

Starts an amendment that leaves the order of the account as it is.

Source

pub const fn volume(self, volume: Volume) -> Self

Changes the volume, in units of the symbol.

Source

pub const fn price(self, price: Price) -> Self

Changes the price the order waits at: the limit price of a limit order, the stop price of a stop or stop-limit order.

Source

pub const fn good_till(self, expiry: Timestamp) -> Self

Keeps the order in force till the given moment.

Source

pub const fn good_till_cancelled(self) -> Self

Keeps the order in force until it is executed or cancelled.

Source

pub fn stop_loss(self, price: Option<Price>) -> Self

Sets the stop loss to the given price, or takes it off the order with None.

Source

pub fn take_profit(self, price: Option<Price>) -> Self

Sets the take profit to the given price, or takes it off the order with None.

Source

pub const fn slippage(self, points: u32) -> Self

Changes the slippage of a stop-limit order, in points of the symbol.

The slippage is bound as that of NewOrder::stop_limit, against the stop price the amendment holds, before the amendment is sent.

Source

pub const fn order(&self) -> OrderId

Returns the order the amendment changes.

Trait Implementations§

Source§

impl Clone for OrderAmendment

Source§

fn clone(&self) -> Self

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 OrderAmendment

Source§

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

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

impl Eq for OrderAmendment

Source§

impl Hash for OrderAmendment

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for OrderAmendment

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OrderAmendment

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

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

fn try_from(value: U) -> Result<T, !>

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