Trait Builder

Source

pub trait Builder: Sized {
    type Item;
    type Time: Timestamp;
    type Output;

    // Required methods
    fn with_capacity(keys: usize, vals: usize, upds: usize) -> Self;
    fn copy(&mut self, element: &Self::Item);
    fn done(
        self,
        lower: Antichain<Self::Time>,
        upper: Antichain<Self::Time>,
        since: Antichain<Self::Time>,
    ) -> Self::Output;

    // Provided methods
    fn new() -> Self { ... }
    fn push(&mut self, element: Self::Item) { ... }
    fn extend<I: Iterator<Item = Self::Item>>(&mut self, iter: I) { ... }
}

Expand description

Functionality for building batches from ordered update sequences.

Required Associated Types§

Source

type Item

Input item type.

Source

type Time: Timestamp

Timestamp type.

Source

type Output

Output batch type.

Required Methods§

Source

fn with_capacity(keys: usize, vals: usize, upds: usize) -> Self

Allocates an empty builder with capacity for the specified keys, values, and updates.

They represent respectively the number of distinct key, (key, val), and total updates.

Source

fn copy(&mut self, element: &Self::Item)

Adds an element to the batch.

Source

fn done( self, lower: Antichain<Self::Time>, upper: Antichain<Self::Time>, since: Antichain<Self::Time>, ) -> Self::Output

Completes building and returns the batch.

Provided Methods§

Source

fn new() -> Self

Allocates an empty builder.

Ideally we deprecate this and insist all non-trivial building happens via with_capacity().

Source

fn push(&mut self, element: Self::Item)

Adds an element to the batch.

The default implementation uses self.copy with references to the owned arguments. One should override it if the builder can take advantage of owned arguments.

Source