Struct MarketUpdate

Source
pub struct MarketUpdate<const N: usize = 32, const T: usize = 16> {
    pub timestamp_ns: u64,
    pub symbol: String,
    pub bid_prices: SmallVec<[Decimal; N]>,
    pub bid_quantities: SmallVec<[Decimal; N]>,
    pub ask_prices: SmallVec<[Decimal; N]>,
    pub ask_quantities: SmallVec<[Decimal; N]>,
    pub trades: SmallVec<[TradeUpdate; T]>,
}
Expand description

Market data for incremental calculation

This struct represents a single market update containing order book data and trades. It uses const generics to allow compile-time optimization of buffer sizes.

§Type Parameters

  • N - The capacity for bid/ask price and quantity vectors (default: 32)

    • Controls the maximum number of order book levels that can be stored
    • Uses SmallVec to avoid heap allocation for typical order book depths
    • Common values: 5-10 for top-of-book strategies, 20-50 for market making, 100+ for full depth analysis
  • T - The capacity for the trades buffer (default: 16)

    • Controls the maximum number of trades that can be stored per update
    • Uses SmallVec to avoid heap allocation for typical trade bursts
    • Common values: 8-16 for normal markets, 32-64 for high-volume periods, 128+ for extremely liquid assets

§Performance Considerations

  • Values up to the specified capacity are stored inline (stack allocated)
  • Exceeding capacity will cause heap allocation, impacting performance
  • Choose capacities based on your specific use case and market characteristics
  • Monitor actual usage to optimize these parameters

§Examples

// Default configuration suitable for most use cases
let update: MarketUpdate = MarketUpdate {
    timestamp_ns: 1_000_000_000,
    symbol: "BTC-USD".to_string(),
    bid_prices: smallvec![/* ... */],
    // ... other fields
};

// High-frequency market maker needing more order book levels
let update: MarketUpdate<64, 32> = MarketUpdate {
    // Can store up to 64 order book levels and 32 trades inline
    // ... fields
};

// Lightweight strategy only caring about top of book
let update: MarketUpdate<5, 8> = MarketUpdate {
    // Only stores top 5 levels and up to 8 trades inline
    // ... fields
};

Fields§

§timestamp_ns: u64

Nanosecond timestamp of the update.

§symbol: String

The trading symbol.

§bid_prices: SmallVec<[Decimal; N]>

A small vector of bid prices.

§bid_quantities: SmallVec<[Decimal; N]>

A small vector of bid quantities.

§ask_prices: SmallVec<[Decimal; N]>

A small vector of ask prices.

§ask_quantities: SmallVec<[Decimal; N]>

A small vector of ask quantities.

§trades: SmallVec<[TradeUpdate; T]>

A small vector of trades.

Trait Implementations§

Source§

impl<const N: usize, const T: usize> Clone for MarketUpdate<N, T>

Source§

fn clone(&self) -> MarketUpdate<N, T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<const N: usize, const T: usize> Debug for MarketUpdate<N, T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const N: usize, const T: usize> Freeze for MarketUpdate<N, T>

§

impl<const N: usize, const T: usize> RefUnwindSafe for MarketUpdate<N, T>

§

impl<const N: usize, const T: usize> Send for MarketUpdate<N, T>

§

impl<const N: usize, const T: usize> Sync for MarketUpdate<N, T>

§

impl<const N: usize, const T: usize> Unpin for MarketUpdate<N, T>

§

impl<const N: usize, const T: usize> UnwindSafe for MarketUpdate<N, T>

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.

§

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

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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
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.
§

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
§

impl<T> ErasedDestructor for T
where T: 'static,