Enum CandlestickItem

pub enum CandlestickItem {
    Confirmed(Candlestick),
    Realtime(Candlestick),
    HistoryEnd,
}

An item yielded by DataProvider::candlesticks.

The three variants let the DataProvider signal the boundary between historical (finite, synchronous) and realtime (potentially infinite, asynchronous) data.

Stream protocol

The expected sequence is:

Confirmed(t0)  Confirmed(t1)  …  Confirmed(tN)   ← historical closed bars
HistoryEnd                                        ← boundary marker (once)
Realtime(tA)                                      ← forming bar, first tick
Realtime(tA)                                      ← same timestamp → update
Realtime(tB)   (tB > tA)                          ← later timestamp:
                                                     VM auto-confirms tA,
                                                     then opens tB
…

Do not emit Confirmed for a realtime bar that has just closed. Send the next Realtime tick with a later timestamp instead; the VM confirms the previous bar automatically.

Examples

use openpine_vm::{Candlestick, CandlestickItem, TradeSession};

let bar = Candlestick::new(
    1_700_000_000_000,
    150.0,
    155.0,
    149.0,
    153.0,
    1_000_000.0,
    0.0,
    TradeSession::Regular,
);

// Historical (confirmed, closed) bar
let _ = CandlestickItem::Confirmed(bar);

// Realtime (forming) bar
let _ = CandlestickItem::Realtime(bar);

// Marks the end of historical data; realtime items follow
let _ = CandlestickItem::HistoryEnd;

Variants

Confirmed(Candlestick)

A confirmed (closed) historical bar.

Only used for historical bars. Do not emit Confirmed to signal that a realtime bar has closed; send the next Realtime tick with a later timestamp and the VM confirms the previous bar automatically.

Realtime(Candlestick)

The current forming (realtime) bar.

Consecutive yields with the same timestamp update the bar in place. A yield with a later timestamp implicitly confirms the previous bar and opens a new one.

HistoryEnd

Marks the boundary between historical and realtime data.

Emit exactly once, after all historical Confirmed bars and before the first Realtime bar. After this item the VM switches from blocking to non-blocking stream consumption so that a stalled or slow symbol never freezes execution.

Trait Implementations

impl Clone for CandlestickItem

fn clone(&self) -> CandlestickItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandlestickItem

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

Formats the value using the given formatter.

impl Copy for CandlestickItem