Struct Candle 

#[non_exhaustive]
pub struct Candle {
    pub open: f64,
    pub high: f64,
    pub low: f64,
    pub close: f64,
    pub volume: f64,
    pub timestamp: i64,
}

A single OHLCV bar.

Timestamps are unitless i64 values so callers can use whatever epoch resolution they prefer (milliseconds, microseconds, seconds…). Wickra never inspects them numerically beyond passing them through.

Construction and the limits of its guarantee

The struct is #[non_exhaustive], so code outside this crate cannot build one from a field literal and must go through new, which validates, or new_unchecked, which is an explicit opt-out for values already known to be sound.

The fields stay public because reading them is by far the common operation and an accessor on each would buy nothing. That does mean a validated value can still be written into an invalid state afterwards, and nothing detects it: the indicators that consume this type rely on the constructor’s guarantee rather than re-checking every bar. Treat a mutation the way you would treat new_unchecked — you are asserting the invariants still hold.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

impl Candle

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

Construct a new candle, validating the OHLC relationships and finiteness.

Errors

Returns Error::InvalidCandle if any of these invariants are violated:

• high >= max(open, close, low)
• low <= min(open, close, high)
• all of open, high, low, close, volume are finite
• volume >= 0

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

Construct a candle without validation. The caller asserts that all OHLC invariants hold and that no field is NaN or infinite.

pub fn typical_price(&self) -> f64

The typical price (high + low + close) / 3. Used by CCI, MFI, VWAP, etc.

pub fn median_price(&self) -> f64

The mid price (high + low) / 2.

pub fn weighted_close(&self) -> f64

The weighted close (high + low + 2*close) / 4.

pub fn avg_price(&self) -> f64

The average price (open + high + low + close) / 4.

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

True range of this candle relative to a previous close: max(H-L, |H-prev|, |L-prev|). If no previous close is supplied, falls back to high - low.

Trait Implementations

impl Clone for Candle

fn clone(&self) -> Candle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Candle

impl Debug for Candle

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

Formats the value using the given formatter.

impl PartialEq for Candle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Candle