Struct mz_stash::StashCollection

pub struct StashCollection<K, V> {
    pub id: Id,
    pub(crate) _kv: PhantomData<(K, V)>,
}

StashCollection is like a differential dataflow Collection, but the state of the collection is durable.

A StashCollection stores (key, value, timestamp, diff) entries. The key and value types are chosen by the caller; they must implement Ord and they must be serializable to and deserializable via serde. The timestamp and diff types are fixed to i64.

A StashCollection maintains a since frontier and an upper frontier, as described in the correctness vocabulary document. To advance the since frontier, call compact. To advance the upper frontier, call seal. To physically compact data beneath the since frontier, call consolidate.

Fields

id: Id

_kv: PhantomData<(K, V)>

Implementations

impl<K, V> StashCollection<K, V>

pub(crate) fn new(id: Id) -> Self

impl<K, V> StashCollection<K, V>

pub async fn make_batch( &self, stash: &mut Stash ) -> Result<AppendBatch, StashError>

Create a new AppendBatch for this collection from its current upper.

pub async fn make_batch_tx( &self, tx: &Transaction<'_> ) -> Result<AppendBatch, StashError>

Create a new AppendBatch for this collection from its current upper.

pub fn make_batch_lower( &self, lower: Antichain<Timestamp> ) -> Result<AppendBatch, StashError>

Create a new AppendBatch for this collection from its current upper.

impl<K, V> StashCollection<K, V>where K: Data, V: Data,

pub fn append_to_batch( &self, batch: &mut AppendBatch, key: &K, value: &V, diff: Diff )

Trait Implementations

impl<K, V> Clone for StashCollection<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for StashCollection<K, V>

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

Formats the value using the given formatter.

impl<K, V> From<i64> for StashCollection<K, V>

fn from(id: Id) -> Self

Converts to this type from the input type.

impl<K, V> Copy for StashCollection<K, V>