Struct FixedBatchGroupGenerator 

pub struct FixedBatchGroupGenerator<'a> { /* private fields */ }

A simple batch group generator, which knows its batches in advance.

For some protocol updates, you might want to use a custom batch group generator, which is more lazy, or sources its work from the database.

Implementations

impl<'a> FixedBatchGroupGenerator<'a>

pub fn named(name: &'static str) -> FixedBatchGroupGenerator<'a>

pub fn add_bespoke_batch( self, batch: impl ProtocolUpdateBatchGenerator + 'a, ) -> FixedBatchGroupGenerator<'a>

pub fn add_batch( self, name: impl Into<String>, generator: impl FnOnce(&dyn SubstateDatabase) -> ProtocolUpdateBatch + 'a, ) -> FixedBatchGroupGenerator<'a>

pub fn build(self) -> Box<dyn ProtocolUpdateBatchGroupGenerator<'a> + 'a>

Trait Implementations

impl<'a> ProtocolUpdateBatchGroupGenerator<'a> for FixedBatchGroupGenerator<'a>

fn batch_group_name(&self) -> &'static str

This is &'static because batch groups are intended to be fixed conceptual steps in the protocol update.

fn generate_batches( self: Box<FixedBatchGroupGenerator<'a>>, _store: &dyn SubstateDatabase, ) -> Vec<Box<dyn ProtocolUpdateBatchGenerator + 'a>>

The content of these batches must be fully reproducible from the state of the store before any updates were committed. This is why we return an array of batch generators.