Struct Bar 

pub struct Bar {
    pub timestamp: i64,
    pub open: f64,
    pub high: f64,
    pub low: f64,
    pub close: f64,
    pub volume: f64,
}

Generic OHLCV Bar data point.

Fields

timestamp: i64

open: f64

high: f64

low: f64

close: f64

volume: f64

Implementations

impl Bar

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

Creates a bar without validation.

Use Bar::try_new at data-ingestion boundaries. This unchecked constructor is retained for trusted feeds and compatibility with existing consumers.

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

Creates a bar after validating the OHLCV input contract.

Examples found in repository

examples/basic_indicator.rs (lines 28-35)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // `build_checked` validates parameters against the registry's bounds/ordering rules for the
    // named indicator (see `kestrel_chartkit::catalog()` for the full list of names and their
    // default parameters) and returns a boxed `Indicator` trait object.
    let mut params = HashMap::new();
    params.insert("rsi_len".to_string(), 14.0);
    let mut rsi = build_checked("rsi", &params)?;

    // A short synthetic closing-price series. Real feeds should validate bars at the ingestion
    // boundary with `Bar::try_new` (as here) rather than the unchecked `Bar::new`.
    let closes = [
        44.34, 44.09, 44.15, 43.61, 44.33, 44.83, 45.10, 45.42, 45.84, 46.08, 45.89, 46.03, 45.61,
        46.28, 46.28, 46.00,
    ];

    for (i, &close) in closes.iter().enumerate() {
        let bar = Bar::try_new(
            1_700_000_000 + i as i64 * 60,
            close,
            close + 0.5,
            close - 0.5,
            close,
            1_000.0,
        )?;

        // `on_bar` returns `None` while the indicator is still warming up (fewer bars seen than
        // its `warmup_period()`); once warmed up it returns `Some` on every subsequent bar.
        match rsi.on_bar(&bar) {
            Some(output) => println!("bar {i:>2}: close={close:.2}  RSI(14)={:.2}", output.value),
            None => println!("bar {i:>2}: close={close:.2}  RSI(14)=<warming up>"),
        }
    }

    Ok(())
}

pub fn typical_price(&self) -> f64

pub fn validate(&self) -> Result<(), BarValidationError>

Verifies that OHLCV prices and volumes satisfy mathematical and physical domain requirements:

• All price values are finite and strictly positive (> 0.0)
• Volume is finite and non-negative (>= 0.0)
• Structural inequality holds: low <= min(open, close) and high >= max(open, close)

pub fn is_valid(&self) -> bool

Returns whether the bar satisfies Bar::validate.

Trait Implementations

impl Clone for Bar

fn clone(&self) -> Bar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bar

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Bar> for ChartBarData

fn from(b: &Bar) -> Self

Converts to this type from the input type.

impl PartialEq for Bar

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Bar

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Bar