Enum Data

Source
#[repr(C)]
pub enum Data { Delta(OrderBookDelta), Deltas(OrderBookDeltas_API), Depth10(Box<OrderBookDepth10>), Quote(QuoteTick), Trade(TradeTick), Bar(Bar), MarkPriceUpdate(MarkPriceUpdate), IndexPriceUpdate(IndexPriceUpdate), InstrumentClose(InstrumentClose), }
Expand description

A built-in Nautilus data type.

Not recommended for storing large amounts of data, as the largest variant is significantly larger (10x) than the smallest.

Variants§

§

Delta(OrderBookDelta)

§

Deltas(OrderBookDeltas_API)

§

Depth10(Box<OrderBookDepth10>)

§

Quote(QuoteTick)

§

Trade(TradeTick)

§

Bar(Bar)

§

MarkPriceUpdate(MarkPriceUpdate)

§

IndexPriceUpdate(IndexPriceUpdate)

§

InstrumentClose(InstrumentClose)

Implementations§

Source§

impl Data

Source

pub fn instrument_id(&self) -> InstrumentId

Returns the instrument ID for the data.

Source

pub fn is_order_book_data(&self) -> bool

Returns whether the data is a type of order book data.

Trait Implementations§

Source§

impl Clone for Data

Source§

fn clone(&self) -> Data

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Data

Source§

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

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

impl<'de> Deserialize<'de> for Data

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Bar> for Data

Source§

fn from(value: Bar) -> Self

Converts to this type from the input type.
Source§

impl From<IndexPriceUpdate> for Data

Source§

fn from(value: IndexPriceUpdate) -> Self

Converts to this type from the input type.
Source§

impl From<InstrumentClose> for Data

Source§

fn from(value: InstrumentClose) -> Self

Converts to this type from the input type.
Source§

impl From<MarkPriceUpdate> for Data

Source§

fn from(value: MarkPriceUpdate) -> Self

Converts to this type from the input type.
Source§

impl From<OrderBookDelta> for Data

Source§

fn from(value: OrderBookDelta) -> Self

Converts to this type from the input type.
Source§

impl From<OrderBookDeltas_API> for Data

Source§

fn from(value: OrderBookDeltas_API) -> Self

Converts to this type from the input type.
Source§

impl From<OrderBookDepth10> for Data

Source§

fn from(value: OrderBookDepth10) -> Self

Converts to this type from the input type.
Source§

impl From<QuoteTick> for Data

Source§

fn from(value: QuoteTick) -> Self

Converts to this type from the input type.
Source§

impl From<TradeTick> for Data

Source§

fn from(value: TradeTick) -> Self

Converts to this type from the input type.
Source§

impl GetTsInit for Data

Source§

impl PartialEq for Data

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Data

Source§

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

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

impl TryFrom<Data> for Bar

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for IndexPriceUpdate

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for InstrumentClose

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for MarkPriceUpdate

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for OrderBookDelta

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for OrderBookDeltas_API

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for OrderBookDepth10

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for QuoteTick

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Data> for TradeTick

Source§

type Error = ()

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

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl StructuralPartialEq for Data

Auto Trait Implementations§

§

impl Freeze for Data

§

impl RefUnwindSafe for Data

§

impl Send for Data

§

impl Sync for Data

§

impl Unpin for Data

§

impl UnwindSafe for Data

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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Ungil for T
where T: Send,