Skip to main content

MarketEvent

Enum MarketEvent 

Source
pub enum MarketEvent {
    Tick {
        symbol: String,
        ts: NaiveDateTime,
        bid: f64,
        ask: f64,
    },
    Bar {
        symbol: String,
        ts: NaiveDateTime,
        open: f64,
        high: f64,
        low: f64,
        close: f64,
        volume: i64,
        spread: Option<f64>,
        timeframe_seconds: Option<u64>,
        tick_count: Option<u64>,
    },
}
Expand description

A single market data event consumed by the backtest runner.

Variants§

§

Tick

A bid/ask tick.

Fields

§symbol: String
§bid: f64
§ask: f64
§

Bar

An OHLCV bar.

Fields

§symbol: String
§open: f64
§high: f64
§low: f64
§close: f64
§volume: i64
§spread: Option<f64>

Symmetric bid/ask spread in price units observed while the bar formed.

None means the spread is unknown, which keeps the historical zero-spread approximation for feeds that cannot supply it.

§timeframe_seconds: Option<u64>

Length of the bar’s bucket in seconds when the source knows it; a strategy series accepts a stored bar only when this matches its timeframe.

§tick_count: Option<u64>

Number of ticks the bar aggregated when the source recorded it, which a strategy series reports as the bar’s tick count.

Implementations§

Source§

impl MarketEvent

Source

pub fn ts(&self) -> NaiveDateTime

Timestamp of the event.

Source

pub fn symbol(&self) -> &str

Symbol of the event.

Source

pub fn to_quote(&self) -> PriceQuote

Convert the event into a PriceQuote suitable for the trade engine.

A tick carries its own two-sided quote. A bar yields its closing quote, with its recorded spread applied symmetrically around the close; FutureQuote replay executes a bar through MarketEvent::bar_execution_prices instead, over its open, range, and close. A bar without a recorded spread keeps the zero-spread approximation; use MarketEvent::to_quote_with_spread_fallback to supply one.

Source

pub fn to_quote_with_spread_fallback(&self, fallback: Option<f64>) -> PriceQuote

Convert the event into a PriceQuote, applying fallback when a bar has no recorded spread.

fallback is expressed in price units and applied symmetrically around the bar close. It is ignored for ticks and for bars that already carry a spread.

Source

pub fn bar_execution_prices( &self, fallback: Option<f64>, ) -> Option<BarExecutionPrices>

The execution view of a bar: its prices and half of the spread applied around each of them, using fallback when the bar records no spread. None for a tick.

Source

pub fn is_zero_spread_bar(&self) -> bool

Whether this event is a bar that carries no usable spread.

Source

pub fn to_valid_quote(&self) -> Option<PriceQuote>

Convert this event into a quote only when its executable bid/ask view is finite, positive, and not crossed.

Trait Implementations§

Source§

impl Clone for MarketEvent

Source§

fn clone(&self) -> Self

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 Debug for MarketEvent

Source§

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

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

impl<'de> Deserialize<'de> for MarketEvent

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 EventSourceItem for MarketEvent

Source§

impl Serialize for MarketEvent

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V