Struct TimeBarAggregator 

pub struct TimeBarAggregator {
    pub historical_mode: bool,
    /* private fields */
}

Provides a means of building time bars aggregated from quote and trades.

At each aggregation time interval, a bar is created and sent to the handler.

Fields

historical_mode: bool

Implementations

impl TimeBarAggregator

pub fn new<H: FnMut(Bar) + 'static>( bar_type: BarType, price_precision: u8, size_precision: u8, clock: Rc<RefCell<dyn Clock>>, handler: H, build_with_no_updates: bool, timestamp_on_close: bool, interval_type: BarIntervalType, time_bars_origin_offset: Option<SignedDuration>, time_zone: TimeZone, bar_build_delay: u64, skip_first_non_full_bar: bool, ) -> Self

Creates a new TimeBarAggregator instance.

time_zone aligns day, week, month, and year boundaries to local civil time. Shorter periods keep UTC alignment. time_bars_origin_offset shifts the nominal boundary; bar_build_delay adds an elapsed delay in microseconds after each resolved boundary.

Panics

Panics if bar_type.aggregation_source is not AggregationSource::Internal.

pub fn set_clock_internal(&mut self, clock: Rc<RefCell<dyn Clock>>)

Sets the clock for the aggregator (internal method).

pub fn start_timer_internal( &mut self, aggregator_rc: Option<Rc<RefCell<Box<dyn BarAggregator>>>>, )

Starts the time bar aggregator, scheduling periodic bar builds on the clock.

Creates a callback to build_bar using a weak reference to the aggregator.

Panics

Panics if aggregator_rc is None and aggregator_weak hasn’t been set, or if timer registration fails.

pub fn stop(&mut self)

Stops the time bar aggregator.

pub fn set_historical_events_internal(&mut self, events: Vec<TimeEvent>)

Sets historical events (called by data engine after advancing clock)

Trait Implementations

impl BarAggregator for TimeBarAggregator

fn stop(&mut self)

Stop time-based aggregator by canceling its timer.

fn bar_type(&self) -> BarType

The [BarType] to be aggregated.

fn is_running(&self) -> bool

If the aggregator is running and will receive data from the message bus.

fn set_is_running(&mut self, value: bool)

Sets the running state of the aggregator (receiving updates when true).

fn update(&mut self, price: Price, size: Quantity, ts_init: UnixNanos)

Updates the aggregator with the given price and size.

fn update_bar(&mut self, bar: Bar, volume: Quantity, ts_init: UnixNanos)

fn set_historical_mode( &mut self, historical_mode: bool, handler: Box<dyn FnMut(Bar)>, )

Sets historical mode and the handler used for completed bars.

fn set_historical_events(&mut self, events: Vec<TimeEvent>)

Sets historical events (default implementation does nothing, TimeBarAggregator overrides)

fn set_clock(&mut self, clock: Rc<RefCell<dyn Clock>>)

Sets clock for time bar aggregators (default implementation does nothing, TimeBarAggregator overrides)

fn build_bar(&mut self, event: &TimeEvent)

Builds a bar from a time event (default implementation does nothing, TimeBarAggregator overrides)

fn set_aggregator_weak(&mut self, weak: Weak<RefCell<Box<dyn BarAggregator>>>)

Sets the weak reference to the aggregator wrapper (for historical mode). Default implementation does nothing, TimeBarAggregator overrides.

fn start_timer( &mut self, aggregator_rc: Option<Rc<RefCell<Box<dyn BarAggregator>>>>, )

Starts the timer for time bar aggregators. Default implementation does nothing, TimeBarAggregator overrides. Takes an optional Rc to create weak reference internally.

fn set_adjustment( &mut self, adjustment: Decimal, mode: ContinuousFutureAdjustmentType, )

Configures the continuous-future price adjustment for the underlying builder.

fn set_build_with_no_updates(&mut self, value: bool)

Sets whether empty intervals emit bars at the last close. Default implementation does nothing, TimeBarAggregator overrides.

fn is_historical(&self) -> bool

If the aggregator is processing historical data on a private clock. Default implementation returns false, TimeBarAggregator overrides.

fn handle_quote(&mut self, quote: QuoteTick)

Updates the aggregator with the given quote.

fn handle_trade(&mut self, trade: TradeTick)

Updates the aggregator with the given trade.

fn handle_bar(&mut self, bar: Bar)

Updates the aggregator with the given bar.

impl Debug for TimeBarAggregator

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

Formats the value using the given formatter.