Struct Spine 

pub struct Spine<B: Batch> { /* private fields */ }

An append-only collection of update tuples.

A spine maintains a small number of immutable collections of update tuples, merging the collections when two have similar sizes. In this way, it allows the addition of more tuples, which may then be merged with other immutable collections.

Implementations

impl<B: Batch> Spine<B>

pub fn with_effort( effort: usize, operator: OperatorInfo, logger: Option<Logger>, activator: Option<Activator>, ) -> Self

Allocates a fueled Spine with a specified effort multiplier.

This trace will merge batches progressively, with each inserted batch applying a multiple of the batch’s length in effort to each merge. The effort parameter is that multiplier. This value should be at least one for the merging to happen; a value of zero is not helpful.

pub fn introduce_batch(&mut self, batch: Option<B>, batch_index: usize)

Introduces a batch at an indicated level.

The level indication is often related to the size of the batch, but it can also be used to artificially fuel the computation by supplying empty batches at non-trivial indices, to move merges along.

pub fn apply_fuel(&mut self, fuel: &mut isize)

Applies an amount of fuel to merges in progress.

The supplied fuel is for each in progress merge, and if we want to spend the fuel non-uniformly (e.g. prioritizing merges at low layers) we could do so in order to maintain fewer batches on average (at the risk of completing merges of large batches later, but tbh probably not much later).

Trait Implementations

impl<B: Batch> Drop for Spine<B>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<B: Batch + Clone + 'static> Trace for Spine<B>

fn exert(&mut self)

Apply some amount of effort to trace maintenance.

Whether and how much effort to apply is determined by self.exert_logic, a closure the user can set.

fn close(&mut self)

Completes the trace with a final empty batch.

fn new( info: OperatorInfo, logging: Option<Logger>, activator: Option<Activator>, ) -> Self

Allocates a new empty trace.

fn set_exert_logic(&mut self, logic: ExertionLogic)

Sets the logic for exertion in the absence of updates.

fn insert(&mut self, batch: Self::Batch)

Introduces a batch of updates to the trace.

impl<B: Batch + Clone + 'static> TraceReader for Spine<B>

type Time = <B as BatchReader>::Time

The timestamp type of the trace’s updates.

type Batch = B

The type of an immutable collection of updates.

fn batches_through( &mut self, upper: AntichainRef<'_, Self::Time>, ) -> Option<Vec<Self::Batch>>

Acquires the non-empty sequence of batches covering updates at times not greater or equal to an element of upper.

fn set_logical_compaction(&mut self, frontier: AntichainRef<'_, B::Time>)

Advances the frontier that constrains logical compaction.

fn get_logical_compaction(&mut self) -> AntichainRef<'_, B::Time>

Reports the logical compaction frontier.

fn set_physical_compaction(&mut self, frontier: AntichainRef<'_, B::Time>)

Advances the frontier that constrains physical compaction.

fn get_physical_compaction(&mut self) -> AntichainRef<'_, B::Time>

Reports the physical compaction frontier.

fn map_batches<F: FnMut(&Self::Batch)>(&self, f: F)

Maps logic across the non-empty sequence of batches in the trace.

fn cursor( &mut self, ) -> (CursorList<<Self::Batch as Navigable>::Cursor>, Vec<Self::Batch>)

where Self::Batch: Navigable,

Provides a cursor over updates contained in the trace.

fn cursor_through( &mut self, upper: AntichainRef<'_, Self::Time>, ) -> Option<(CursorList<<Self::Batch as Navigable>::Cursor>, Vec<Self::Batch>)>

where Self::Batch: Navigable,

Acquires a cursor to the restriction of the collection’s contents to updates at times not greater or equal to an element of upper.

fn read_upper(&mut self, target: &mut Antichain<Self::Time>)

Reads the upper frontier of committed times.

fn advance_upper(&mut self, upper: &mut Antichain<Self::Time>)

Advances upper by any empty batches.