Skip to main content

Candle

Struct Candle 

Source
pub struct Candle {
    pub open: f64,
    pub high: f64,
    pub low: f64,
    pub close: f64,
    pub volume: f64,
    pub timestamp: i64,
}
Expand description

One OHLCV bar.

Field order and semantics match wickra_core::ohlcv::Candle, so a candle built here feeds the parity oracle unchanged. Copy keeps the indicator update path allocation- and clone-free.

Fields§

§open: f64

Bar open price.

§high: f64

Bar high price.

§low: f64

Bar low price.

§close: f64

Bar close price.

§volume: f64

Bar volume.

§timestamp: i64

Bar timestamp (caller-defined epoch / resolution).

Implementations§

Source§

impl Candle

Source

pub const fn new( open: f64, high: f64, low: f64, close: f64, volume: f64, timestamp: i64, ) -> Self

Construct a candle from its fields. Unlike the std Candle::new, this is a plain const constructor with no validation: on bare metal the caller (the C ABI, the firmware) is trusted to pass finite, ordered OHLC values, and a validating constructor would add a panic path the core forbids.

Source

pub fn true_range(&self, prev_close: Option<f64>) -> f64

True range for this bar given the previous close, identical to wickra-core: max(high - low, |high - prev|, |low - prev|), or just high - low for the first bar.

Trait Implementations§

Source§

impl Clone for Candle

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 Copy for Candle

Source§

impl Debug for Candle

Source§

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

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

impl PartialEq for Candle

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Candle

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