nautilus_data::aggregation

Struct ValueBarAggregator

Source
pub struct ValueBarAggregator<H>
where H: FnMut(Bar),
{ /* private fields */ }
Expand description

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

When received value reaches the step threshold of the bar specification, then a bar is created and sent to the handler.

Implementations§

Source§

impl<H> ValueBarAggregator<H>
where H: FnMut(Bar),

Source

pub fn new( instrument: &InstrumentAny, bar_type: BarType, handler: H, await_partial: bool, ) -> Self

Creates a new ValueBarAggregator 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 const fn get_cumulative_value(&self) -> f64

Returns the cumulative value for the aggregator.

Trait Implementations§

Source§

impl<H> BarAggregator for ValueBarAggregator<H>
where H: FnMut(Bar),

Source§

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

Apply the given update to the aggregator.

Source§

fn bar_type(&self) -> BarType

The [BarType] to be aggregated.
Source§

fn handle_quote(&mut self, quote: QuoteTick)

Updates the aggregator with the given quote.
Source§

fn handle_trade(&mut self, trade: TradeTick)

Updates the aggregator with the given trade.

Auto Trait Implementations§

§

impl<H> Freeze for ValueBarAggregator<H>
where H: Freeze,

§

impl<H> RefUnwindSafe for ValueBarAggregator<H>
where H: RefUnwindSafe,

§

impl<H> Send for ValueBarAggregator<H>
where H: Send,

§

impl<H> Sync for ValueBarAggregator<H>
where H: Sync,

§

impl<H> Unpin for ValueBarAggregator<H>
where H: Unpin,

§

impl<H> UnwindSafe for ValueBarAggregator<H>
where H: 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,