Skip to main content

CandlestickItem

Enum CandlestickItem

pub enum CandlestickItem {
    Bar(Candlestick),
    HistoryEnd,
}

Expand description

An item yielded by a data provider’s candlestick stream.

§Stream protocol

The expected sequence is:

Bar(t0)  Bar(t1)  …  Bar(tN)   ← historical bars (before HistoryEnd)
HistoryEnd                      ← boundary marker (emitted once)
Bar(tA)                         ← forming realtime bar, first tick
Bar(tA)                         ← same timestamp → in-place update
Bar(tB)  (tB > tA)              ← later timestamp:
                                   VM auto-confirms tA, then opens tB
…

The position of HistoryEnd determines whether a Bar is historical or realtime. Bar items that appear before HistoryEnd are treated as confirmed (closed) historical bars. Items that appear after HistoryEnd are treated as realtime (forming) bars.

Do not emit a Bar to explicitly confirm a realtime bar that has closed. Instead, send the next Bar with a later timestamp and the VM confirms the previous bar automatically.

Variants§

Bar(Candlestick)

A bar. Its role (historical vs. realtime) is determined by whether HistoryEnd has already been emitted.

Before HistoryEnd: treated as a confirmed (closed) historical bar.
After HistoryEnd: treated as the current forming (realtime) bar. Consecutive Bar items with the same timestamp update the bar in place. A Bar 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 Bars and before the first realtime Bar.

Trait Implementations§

impl Clone for CandlestickItem

fn clone(&self) -> CandlestickItem

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

impl Debug for CandlestickItem

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CandlestickItem

fn deserialize<D>( deserializer: D, ) -> Result<CandlestickItem, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for CandlestickItem

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Copy for CandlestickItem

Auto Trait Implementations§

impl Freeze for CandlestickItem

impl RefUnwindSafe for CandlestickItem

impl Send for CandlestickItem

impl Sync for CandlestickItem

impl Unpin for CandlestickItem

impl UnsafeUnpin for CandlestickItem

impl UnwindSafe for CandlestickItem

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

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> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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