Skip to main content

DataRef

Enum DataRef 

Source
pub enum DataRef<'a> {
Show 14 variants BookDelta(&'a OrderBookDelta), BookDeltas(&'a OrderBookDeltas), BookDepth10(&'a OrderBookDepth10), Quote(&'a QuoteTick), Trade(&'a TradeTick), Bar(&'a Bar), MarkPrice(&'a MarkPriceUpdate), IndexPrice(&'a IndexPriceUpdate), FundingRate(&'a FundingRateUpdate), OptionGreeks(&'a OptionGreeks), InstrumentStatus(&'a InstrumentStatus), InstrumentClose(&'a InstrumentClose), Custom(&'a CustomData), Defi(&'a DefiData),
}
Expand description

A borrowed view of a built-in Nautilus data type.

Variants§

§

BookDelta(&'a OrderBookDelta)

§

BookDeltas(&'a OrderBookDeltas)

§

BookDepth10(&'a OrderBookDepth10)

§

Quote(&'a QuoteTick)

§

Trade(&'a TradeTick)

§

Bar(&'a Bar)

§

MarkPrice(&'a MarkPriceUpdate)

§

IndexPrice(&'a IndexPriceUpdate)

§

FundingRate(&'a FundingRateUpdate)

§

OptionGreeks(&'a OptionGreeks)

§

InstrumentStatus(&'a InstrumentStatus)

§

InstrumentClose(&'a InstrumentClose)

§

Custom(&'a CustomData)

§

Defi(&'a DefiData)

Implementations§

Source§

impl DataRef<'_>

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<'a> Clone for DataRef<'a>

Source§

fn clone(&self) -> DataRef<'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> Copy for DataRef<'a>

Source§

impl<'a> Debug for DataRef<'a>

Source§

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

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

impl<'a> From<&'a Data> for DataRef<'a>

Source§

fn from(value: &'a Data) -> Self

Converts to this type from the input type.
Source§

impl HasTsInit for DataRef<'_>

Source§

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for DataRef<'a>

§

impl<'a> !UnwindSafe for DataRef<'a>

§

impl<'a> Freeze for DataRef<'a>

§

impl<'a> Send for DataRef<'a>

§

impl<'a> Sync for DataRef<'a>

§

impl<'a> Unpin for DataRef<'a>

§

impl<'a> UnsafeUnpin for DataRef<'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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.