Struct OhlcBar 

pub struct OhlcBar { /* private fields */ }

A primitive OHLC bar.

Implementations

impl OhlcBar

pub fn new( time: BarTime, interval: BarInterval, open: MarketPrice, high: MarketPrice, low: MarketPrice, close: MarketPrice, ) -> Result<Self, BarError>

Creates an OHLC bar from validated price values.

Errors

Returns BarError::InvalidHigh or BarError::InvalidLow when obvious OHLC constraints are violated.

pub fn from_values( time: BarTime, interval: BarInterval, open: f64, high: f64, low: f64, close: f64, ) -> Result<Self, BarError>

Creates an OHLC bar from raw f64 price values.

Errors

Returns BarError when any price is invalid or OHLC constraints are violated.

pub const fn time(&self) -> &BarTime

Returns the bar time label.

pub const fn interval(&self) -> &BarInterval

Returns the bar interval.

pub const fn open(&self) -> MarketPrice

Returns the open price.

pub const fn high(&self) -> MarketPrice

Returns the high price.

pub const fn low(&self) -> MarketPrice

Returns the low price.

pub const fn close(&self) -> MarketPrice

Returns the close price.

Trait Implementations

impl Clone for OhlcBar

fn clone(&self) -> OhlcBar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OhlcBar

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

Formats the value using the given formatter.

impl PartialEq for OhlcBar

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OhlcBar