Skip to main content

OrderParts

brokapi::tbank::map::order

Struct OrderParts

pub struct OrderParts {
    pub exchange_id: String,
    pub request_id: String,
    pub status: OrderExecutionReportStatus,
    pub lots_requested: i64,
    pub lots_executed: i64,
    pub lot_size: i64,
    pub unit_price: Option<Price>,
    pub direction: OrderDirection,
    pub order_type: OrderType,
    pub instrument: InstrumentId,
    pub reason: String,
    pub broker_ts: Option<Timestamp>,
}

Expand description

What every order message (unary state, placement response, stream update) has in common.

Fields§

§exchange_id: String

The exchange order id (order_id). Empty when the message has none.

§request_id: String

The order_request_id: the idempotency key we sent, as text. Empty for an order placed elsewhere.

§status: OrderExecutionReportStatus

The order status as the broker reports it.

§lots_requested: i64

Lots requested.

§lots_executed: i64

Lots executed so far.

§lot_size: i64

Units of the instrument in one lot. 1 until the caller sets it (OrderParts::with_lot): the message of a unary call does not carry it, the order stream message does (lot_size).

§unit_price: Option<Price>

Price of one instrument, if the message carries a non-zero one.

§direction: OrderDirection

Buy or sell, as the broker reports it.

§order_type: OrderType

Limit, market or best price, as the broker reports it.

§instrument: InstrumentId

The instrument, built from the uid, figi or ticker the message carries.

§reason: String

The broker’s text for a refusal, if any (the placement response message, or the cause of a stream status).

§broker_ts: Option<Timestamp>

The broker’s time of the message, if it gave one.

Implementations§

impl OrderParts

pub fn with_lot(self, lot_size: i64) -> OrderParts

The same parts with the lot size of the instrument set. A lot below 1 is read as 1.

pub fn qty_requested(&self) -> Qty

Quantity requested, in units of the instrument.

pub fn qty_executed(&self) -> Qty

Quantity executed so far, in units of the instrument.

pub fn qty_left(&self) -> Qty

Quantity not executed yet, in units of the instrument (never below zero).

pub fn cid(&self) -> Uuid

Our cid, or a stable stand-in for an order placed elsewhere.

pub fn is_ours(&self) -> bool

true when request_id is a cid of ours, so the order was placed by this library.

Trait Implementations§

impl Clone for OrderParts

fn clone(&self) -> OrderParts

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 OrderParts

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for OrderParts

impl RefUnwindSafe for OrderParts

impl Send for OrderParts

impl Sync for OrderParts

impl Unpin for OrderParts

impl UnsafeUnpin for OrderParts

impl UnwindSafe for OrderParts

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<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].

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