Skip to main content

BarBuilder

Struct BarBuilder 

Source
pub struct BarBuilder { /* private fields */ }
Expand description

Provides a generic bar builder for aggregation.

Implementations§

Source§

impl BarBuilder

Source

pub fn new(bar_type: BarType, price_precision: u8, size_precision: u8) -> Self

Creates a new BarBuilder instance.

§Panics

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

Source

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

Configures the per-tick continuous-future price adjustment.

Adjustment applies on ingress in Self::update and Self::update_bar, so the running OHLC state is always in the adjusted (common) frame. The adjustment configuration is retained across Self::reset so it spans subsequent bars within the same continuous- future segment.

§Panics

Panics if scaling the spread adjustment to the fixed-point representation overflows.

Source

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

Updates the builder state with the given price, size, and init timestamp.

§Panics

Panics if high or low values are unexpectedly None when updating.

Source

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

Updates the builder state with a completed bar, its volume, and the bar init timestamp.

§Panics

Panics if high or low values are unexpectedly None when updating.

Source

pub fn reset(&mut self)

Resets per-bar OHLCV state.

Adjustment configuration set via Self::set_adjustment is retained across resets so it spans subsequent bars within the same continuous-future segment.

Source

pub fn build_now(&mut self) -> Bar

Return the aggregated bar and reset.

Source

pub fn build(&mut self, ts_event: UnixNanos, ts_init: UnixNanos) -> Bar

Returns the aggregated bar for the given timestamps, then resets the builder.

§Panics

Panics if open, high, low, or close values are None when building the bar.

Trait Implementations§

Source§

impl Debug for BarBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

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