Struct ReaderWheel

pub struct ReaderWheel<A>
where
    A: Aggregator,
{ /* private fields */ }

A reader wheel containing a hierarchical aggregate wheel Haw backed by interior mutability.

By default allows a single reader using RefCell, and multiple-readers with the sync flag enabled using parking_lot

Implementations

impl<A> ReaderWheel<A>

where A: Aggregator,

pub fn new(time: u64) -> Self

Creates a new Wheel starting from the given time with default configuration

Time is represented as milliseconds

pub fn with_conf(conf: HawConf) -> Self

Creates a new Wheel starting from the given configuration

pub fn from_delta_state(state: DeltaState<A::PartialAggregate>) -> Self

Creates a new Wheel from a set of deltas

pub fn delta_state(&self) -> DeltaState<A::PartialAggregate>

Returns the current Delta State for the Reader Wheel

pub fn len(&self) -> usize

Returns the number of wheel slots used

pub fn is_empty(&self) -> bool

Returns true if the internal wheel time has never been advanced

pub fn is_full(&self) -> bool

Returns true if all slots in the hierarchy are utilised

pub fn remaining_ticks(&self) -> u64

Returns how many ticks (seconds) are left until the wheel is fully utilised

pub fn to_prefix_wheels(&self)

Converts all wheels to be prefix-enabled

See Haw::to_prefix_wheels for more information

pub fn to_simd_wheels(&self)

Organizes all wheels to be contigious to support explicit SIMD execution.

See Haw::to_simd_wheels for more information

pub fn current_time_in_cycle(&self) -> Duration

Returns Duration that represents where the wheel currently is in its cycle

pub fn schedule_once( &self, at: u64, f: impl Fn(&Haw<A>) + 'static, ) -> Result<(), TimerError<TimerAction<A>>>

Available on crate feature timer only.

Schedules a timer to fire once the given time has been reached

See Haw::schedule_once for more information.

pub fn schedule_repeat( &self, at: u64, interval: Duration, f: impl Fn(&Haw<A>) + 'static, ) -> Result<(), TimerError<TimerAction<A>>>

Available on crate feature timer only.

Schedules a timer to fire repeatedly

See Haw::schedule_repeat for more information.

pub fn delta_advance( &self, deltas: impl IntoIterator<Item = Option<A::PartialAggregate>>, )

Advances the wheel by applying a set of deltas, each representing the lowest unit.

See Haw::delta_advance for more information.

pub fn clear(&self)

Clears the state of all wheels

pub fn watermark(&self) -> u64

Return the current watermark as milliseconds for this wheel

pub fn interval_and_lower(&self, dur: Duration) -> Option<A::Aggregate>

Returns the aggregate in the given time interval

pub fn interval(&self, dur: Duration) -> Option<A::PartialAggregate>

Returns the partial aggregate in the given time interval

See Haw::interval for more information.

pub fn interval_with_ops( &self, dur: Duration, ) -> (Option<A::PartialAggregate>, usize)

Returns the partial aggregate in the given time interval and the number of combine operations

pub fn combine_range( &self, range: impl Into<WheelRange>, ) -> Option<A::PartialAggregate>

Combines partial aggregates within the given date range [start, end) into a final partial aggregate

Returns None if the range cannot be answered by the wheel

See Haw::combine_range for more information.

pub fn combine_range_and_lower( &self, range: impl Into<WheelRange>, ) -> Option<A::Aggregate>

Combines aggregates within the given date range [start, end) into a final partial aggregate

Returns None if the range cannot be answered by the wheel

See Haw::combine_range_and_lower for more information.

pub fn group_by( &self, range: WheelRange, interval: Duration, ) -> Option<Vec<(u64, A::Aggregate)>>

Groups the data into aggregates based on the given range and interval

Returns None if the range cannot be answered by the wheel

Arguments

• range - The range to group the data (e.g., 2024-05-06 00:00:00 - 2024-05-10 00:00:00)
• interval - The duration which aggregates are grouped into (e.g., 1d)

See Haw::group_by for more information.

pub fn range( &self, range: impl Into<WheelRange>, ) -> Option<Vec<(u64, A::PartialAggregate)>>

Returns partial aggregates within the given date range [start, end) using the lowest granularity

Returns None if the range cannot be answered by the wheel

See Haw::range for more information.

pub fn range_and_lower( &self, range: impl Into<WheelRange>, ) -> Option<Vec<(u64, A::Aggregate)>>

Returns aggregates within the given date range [start, end) using the lowest granularity

Returns None if the range cannot be answered by the wheel

See Haw::range_and_lower for more information.

pub fn landmark(&self) -> Option<A::PartialAggregate>

Executes a Landmark Window that combines total partial aggregates across all wheels

See Haw::landmark for more information.

pub fn merge(&self, other: &Self)

Merges another ReaderWheel into this one

pub fn as_ref(&self) -> HawRef<'_, A>

Returns a reference to the internal Haw data structure

Trait Implementations

impl<A> Clone for ReaderWheel<A>

where A: Aggregator + Clone,

fn clone(&self) -> ReaderWheel<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, A> Deserialize<'de> for ReaderWheel<A>

where A: Aggregator + Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A: Aggregator> From<Haw<A>> for ReaderWheel<A>

fn from(value: Haw<A>) -> Self

Converts to this type from the input type.

impl<A> Serialize for ReaderWheel<A>

where A: Aggregator + Default,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.