Struct ZeroCopyOrderBookUpdate

Source
#[repr(C)]
pub struct ZeroCopyOrderBookUpdate<const N: usize = 10> { pub symbol_id: u32, pub _padding1: u32, pub sequence: u64, pub timestamp_ns: u64, pub bid_count: u8, pub ask_count: u8, pub _padding2: [u8; 6], pub bids: [ZeroCopyPriceLevel; N], pub asks: [ZeroCopyPriceLevel; N], }
Expand description

Zero-copy order book update with const generic array sizing

Fixed-size structure for receiving binary order book updates from exchanges. Supports up to N levels per side where N is compile-time configurable.

NOTE: Cannot derive Pod/Zeroable due to const generic parameter N. Bytemuck doesn’t support generic arrays [T; N] for arbitrary N. We maintain manual unsafe implementations for this struct only.

Fields§

§symbol_id: u32

Symbol identifier (exchange-specific)

§_padding1: u32

Padding for alignment

§sequence: u64

Sequence number for detecting gaps

§timestamp_ns: u64

Exchange timestamp in nanoseconds

§bid_count: u8

Number of valid bid levels (0-N)

§ask_count: u8

Number of valid ask levels (0-N)

§_padding2: [u8; 6]

Padding for alignment

§bids: [ZeroCopyPriceLevel; N]

Bid levels (only first bid_count are valid)

§asks: [ZeroCopyPriceLevel; N]

Ask levels (only first ask_count are valid)

Implementations§

Source§

impl<const N: usize> ZeroCopyOrderBookUpdate<N>

Source

pub fn valid_bids(&self) -> &[ZeroCopyPriceLevel]

Get valid bid levels as a slice

Source

pub fn valid_asks(&self) -> &[ZeroCopyPriceLevel]

Get valid ask levels as a slice

Source§

impl<const N: usize> ZeroCopyOrderBookUpdate<N>

Source

pub const fn as_bytes(&self) -> &[u8]

Convert this structure to bytes

§Safety

This uses unsafe to convert the struct to a byte slice. Safe because:

  • The struct is #[repr(C)] with known layout
  • All fields are Pod types (primitives and arrays of Pod)
  • No padding issues due to explicit padding fields

NOTE: We can’t use bytemuck::bytes_of here because this struct can’t implement Pod due to the const generic parameter N.

Source

pub const fn new_zeroed() -> Self

Create a new zeroed instance

§Safety

This uses unsafe to create a zeroed instance. Safe because:

  • All fields are primitives or arrays of primitives
  • Zero is a valid bit pattern for all our fields
  • No references or other types that could be invalid when zeroed

NOTE: We can’t use bytemuck::Zeroable::zeroed() here because this struct can’t implement Zeroable due to the const generic parameter N.

Source

pub const fn size() -> usize

Get the size of this structure at compile time

Source

pub const fn max_levels() -> usize

Get the maximum number of levels per side

Source

pub const fn buffer_size_for_levels(levels: usize) -> usize

Calculate total buffer size needed for N levels

Source

pub const fn has_valid_bid_count(&self) -> bool

Check if the update has valid bid count

Source

pub const fn has_valid_ask_count(&self) -> bool

Check if the update has valid ask count

Source

pub fn from_bytes(bytes: &[u8]) -> Option<&Self>

Create from bytes

Uses the generic parse_message_generic function which handles types that can’t implement Pod due to const generics.

Trait Implementations§

Source§

impl<const N: usize> Clone for ZeroCopyOrderBookUpdate<N>

Source§

fn clone(&self) -> ZeroCopyOrderBookUpdate<N>

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> Debug for ZeroCopyOrderBookUpdate<N>

Source§

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

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

impl<const N: usize> Copy for ZeroCopyOrderBookUpdate<N>

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.

§

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,