nautilus_data::aggregation

Struct TimeBarAggregator

source
pub struct TimeBarAggregator<C>
where C: Clock,
{ /* private fields */ }
Expand description

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

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

Implementations§

source§

impl<C> TimeBarAggregator<C>
where C: Clock + 'static,

source

pub fn new( instrument: &InstrumentAny, bar_type: BarType, handler: fn(_: Bar), await_partial: bool, clock: C, build_with_no_updates: bool, timestamp_on_close: bool, interval_type: &str, ) -> Self

Creates a new TimeBarAggregator instance.

§Panics

This function panics:

  • If instrument.id is not equal to the bar_type.instrument_id.
  • If bar_type.aggregation_source is not equal to AggregationSource::Internal.
source

pub fn start(&mut self, callback: NewBarCallback<C>) -> Result<()>

Starts the time bar aggregator.

source

pub fn stop(&mut self)

Stops the time bar aggregator.

Trait Implementations§

source§

impl<C> BarAggregator for TimeBarAggregator<C>
where C: Clock,

source§

fn bar_type(&self) -> BarType

The [BarType] to be aggregated.
source§

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

Updates theaggregator with the given price and size.
source§

fn handle_quote_tick(&mut self, quote: QuoteTick)

Updates the aggregator with the given quote.
source§

fn handle_trade_tick(&mut self, trade: TradeTick)

Updates the aggregator with the given trade.

Auto Trait Implementations§

§

impl<C> Freeze for TimeBarAggregator<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for TimeBarAggregator<C>
where C: RefUnwindSafe,

§

impl<C> Send for TimeBarAggregator<C>
where C: Send,

§

impl<C> Sync for TimeBarAggregator<C>
where C: Sync,

§

impl<C> Unpin for TimeBarAggregator<C>
where C: Unpin,

§

impl<C> UnwindSafe for TimeBarAggregator<C>
where C: UnwindSafe,

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Ungil for T
where T: Send,