Skip to main content

OrderView

Struct OrderView 

Source
pub struct OrderView<'a> {
Show 28 fields pub order_id: u64, pub symbol_id: u32, pub client_order_id: &'a str, pub side: EnumValue<Side>, pub status: EnumValue<OrderStatus>, pub order_type: EnumValue<OrderType>, pub time_in_force: EnumValue<TimeInForce>, pub self_trade_prevention_mode: EnumValue<SelfTradePreventionMode>, pub fee_asset: EnumValue<FeeAsset>, pub post_only: bool, pub orig_qty_scaled: i64, pub cum_qty_scaled: i64, pub leaves_qty_scaled: i64, pub avg_price_ticks: i64, pub price_ticks: i64, pub created_ts_ns: u64, pub terminal_ts_ns: u64, pub terminal_reason_code: u32, pub terminal_reason: &'a str, pub attached_risk: MessageFieldView<AttachedRiskView<'a>>, pub origin: MessageFieldView<OrderOriginView<'a>>, pub market_client_ref_price_ticks: i64, pub market_max_slippage_ticks: i32, pub market_max_slippage_bps: i32, pub version: u32, pub batch_request_id: u64, pub submitted_max_quote_debit_scaled: Option<i64>, pub __buffa_unknown_fields: UnknownFieldsView<'a>,
}
Expand description

§============================================================================= Connect/Proto-facing Messages (scaled ints, fixed64 IDs)

Order is the Connect-facing order view with compact binary fields.

Fields§

§order_id: u64

Public order identifier as fixed64.

Field 1: order_id

§symbol_id: u32

Trading symbol numeric identifier.

Field 3: symbol_id

§client_order_id: &'a str

Client-provided id for idempotency/correlation (may be empty).

Field 4: client_order_id

§side: EnumValue<Side>

Order side.

Field 5: side

§status: EnumValue<OrderStatus>

Current order lifecycle status.

Field 6: status

§order_type: EnumValue<OrderType>

Order type.

Field 7: order_type

§time_in_force: EnumValue<TimeInForce>

Time-in-force policy.

Field 8: time_in_force

§self_trade_prevention_mode: EnumValue<SelfTradePreventionMode>

Self-trade prevention mode.

Field 9: self_trade_prevention_mode

§fee_asset: EnumValue<FeeAsset>

Fee asset selected for fills. This also determines the decode scale for fee_scaled and referral_share_scaled on user trade rows.

Field 10: fee_asset

§post_only: bool

True if the order was submitted as post-only (maker-only).

Field 11: post_only

§orig_qty_scaled: i64

Original order quantity scaled by the pair’s base_quantity_scale from GetSpotConfig for symbol_id.

Field 12: orig_qty_scaled

§cum_qty_scaled: i64

Cumulative filled quantity scaled by the pair’s base_quantity_scale from GetSpotConfig for symbol_id.

Field 13: cum_qty_scaled

§leaves_qty_scaled: i64

Remaining working quantity scaled by the pair’s base_quantity_scale from GetSpotConfig for symbol_id. Zero for terminal orders.

Field 20: leaves_qty_scaled

§avg_price_ticks: i64

Average fill price in quote units scaled by 1e6. Zero if no fills.

Field 14: avg_price_ticks

§price_ticks: i64

Limit price in quote units scaled by 1e6. Zero for MARKET orders.

Field 15: price_ticks

§created_ts_ns: u64

Creation timestamp in nanoseconds since epoch (UTC).

Field 16: created_ts_ns

§terminal_ts_ns: u64

Terminal timestamp in nanoseconds since epoch (UTC). Zero for open orders.

Field 17: terminal_ts_ns

§terminal_reason_code: u32

Terminal reason code for canceled/rejected orders. Zero for non-terminal orders.

Field 18: terminal_reason_code

§terminal_reason: &'a str

Stable string for terminal_reason_code (e.g. “POST_ONLY_CROSS”, “USER_REQUEST”). Empty for non-terminal orders.

Field 19: terminal_reason

§attached_risk: MessageFieldView<AttachedRiskView<'a>>

Attached risk controls + runtime state on the parent order. Empty when no attached risk exists.

Field 21: attached_risk

§origin: MessageFieldView<OrderOriginView<'a>>

Runtime lineage metadata (why the order exists and what generated it).

Field 22: origin

§market_client_ref_price_ticks: i64

Optional client-side reference price used for MARKET slippage protection, in quote units scaled by 1e6.

Field 23: market_client_ref_price_ticks

§market_max_slippage_ticks: i32

Optional MARKET max slippage as a price delta in 1e-6 quote-unit ticks.

Field 24: market_max_slippage_ticks

§market_max_slippage_bps: i32

Optional MARKET max slippage in basis points (1 bp = 0.01%).

Field 25: market_max_slippage_bps

§version: u32

Per-order state version. Starts at 1 and increases for every published state change. Use this field to reconcile API and realtime updates.

Field 26: version

§batch_request_id: u64

Batch-replace identity that admitted this order. Zero for other origins.

Field 27: batch_request_id

§submitted_max_quote_debit_scaled: Option<i64>

Submitted hard all-in quote debit limit, scaled by the pair’s quote_quantity_scale from GetSpotConfig. Present only when that sizing method was submitted.

Field 28: submitted_max_quote_debit_scaled

§__buffa_unknown_fields: UnknownFieldsView<'a>

Trait Implementations§

Source§

impl<'a> Clone for OrderView<'a>

Source§

fn clone(&self) -> OrderView<'a>

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<'a> Debug for OrderView<'a>

Source§

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

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

impl<'a> Default for OrderView<'a>

Source§

fn default() -> OrderView<'a>

Returns the “default value” for a type. Read more
Source§

impl<'v> DefaultViewInstance for OrderView<'v>

Source§

fn default_view_instance<'a>() -> &'a Self
where Self: 'a,

Return a reference to the single default view instance. Read more
Source§

impl<'a> MessageName for OrderView<'a>

Source§

const PACKAGE: &'static str = "orders.v1"

The protobuf package the message is declared in. Read more
Source§

const NAME: &'static str = "Order"

The unqualified message name, with . between nesting levels. Read more
Source§

const FULL_NAME: &'static str = "orders.v1.Order"

The fully-qualified protobuf type name with no leading dot. Read more
Source§

const TYPE_URL: &'static str = "type.googleapis.com/orders.v1.Order"

The google.protobuf.Any.type_url form for this message. Read more
Source§

impl<'a> MessageView<'a> for OrderView<'a>

Source§

type Owned = Order

The corresponding owned message type.
Source§

fn decode_view(buf: &'a [u8]) -> Result<Self, DecodeError>

Decode a view from a buffer, borrowing string/bytes fields directly. Read more
Source§

fn decode_view_with_ctx( buf: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<Self, DecodeError>

Decode a view under custom decode limits. Read more
Source§

fn merge_view_field( &mut self, tag: Tag, cur: &'a [u8], before_tag: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<&'a [u8], DecodeError>

Decode one field’s payload into this view (generated per message). Read more
Source§

fn to_owned_message(&self) -> Result<Order, DecodeError>

Convert this view to the owned message type. Read more
Source§

fn to_owned_from_source( &self, __buffa_src: Option<&Bytes>, ) -> Result<Order, DecodeError>

Convert this view to the owned message type, optionally slicing bytes::Bytes-typed fields from source instead of copying. Read more
Source§

fn decode_view_ctx( buf: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<Self, DecodeError>
where Self: Default,

Decode a view under an explicit DecodeContext (remaining recursion depth and unknown-field allowance), driving the provided tag loop over merge_view_field. Read more
Source§

fn merge_into_view( &mut self, buf: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from buf into this view (proto merge semantics): repeated fields append, singular fields last-wins, singular message fields merge recursively. Read more
Source§

impl<'__a> Serialize for OrderView<'__a>

Serializes this view as protobuf JSON.

Implicit-presence fields with default values are omitted, required fields are always emitted, explicit-presence (optional) fields are emitted only when set, bytes fields are base64-encoded, and enum values are their proto name strings.

This impl uses serialize_map(None) because the number of emitted fields depends on default-omission rules; serializers that require known map lengths (e.g. bincode) will return a runtime error. Use the owned message type for those formats.

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> ViewEncode<'a> for OrderView<'a>

Source§

fn compute_size(&self, __cache: &mut SizeCache) -> u32

Compute the encoded byte size of this view, recording nested sub-message sizes in cache for write_to to consume. Read more
Source§

fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)

Write this view’s encoded bytes to a buffer, consuming nested-message sizes from cache (populated by a prior compute_size call on the same cache). Read more
Source§

fn encode(&self, buf: &mut impl BufMut)

Compute size, then write. Primary view-encode entry point.
Source§

fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)

Encode using a caller-supplied SizeCache, for reuse across many encodes in a hot loop. Clears the cache first.
Source§

fn encoded_len(&self) -> u32

Compute the encoded byte size of this view. Read more
Source§

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this view as a length-delimited byte sequence.
Source§

fn encode_to_vec(&self) -> Vec<u8>

Encode this view to a new Vec<u8>.
Source§

fn encode_to_bytes(&self) -> Bytes

Encode this view to a new bytes::Bytes.
Source§

impl ViewReborrow for OrderView<'static>

Source§

type Reborrowed<'b> = OrderView<'b>

The same view type with its lifetime shortened to 'b.
Source§

fn reborrow<'b>(this: &'b Self) -> &'b Self::Reborrowed<'b>

Coerce &'b Self (= &'b FooView<'static>) to &'b Self::Reborrowed<'b> (= &'b FooView<'b>). The canonical body is just this; the compiler accepts it via standard lifetime variance for covariant view types. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for OrderView<'a>

§

impl<'a> RefUnwindSafe for OrderView<'a>

§

impl<'a> Send for OrderView<'a>

§

impl<'a> Sync for OrderView<'a>

§

impl<'a> Unpin for OrderView<'a>

§

impl<'a> UnsafeUnpin for OrderView<'a>

§

impl<'a> UnwindSafe for OrderView<'a>

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> JsonSerialize for T
where T: Serialize,

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