Struct ChannelReader

pub struct ChannelReader<P>
where
    P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,
{ /* private fields */ }

ChannelReader is a stateful stage that reads Batches from Channels.

The ChannelReader pulls Channels from the channel bank as raw data and pipes it into a BatchReader. Since the raw data is compressed, the BatchReader first decompresses the data using the first bytes as a compression algorithm identifier.

Once the data is decompressed, it is decoded into a Batch and passed to the next stage in the pipeline.

Implementations

impl<P> ChannelReader<P>

where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,

pub const fn new(prev: P, cfg: Arc<RollupConfig>) -> Self

Create a new ChannelReader stage.

pub fn next_channel(&mut self)

Forces the read to continue with the next channel, resetting any decoding / decompression state to a fresh start.

Trait Implementations

impl<P> BatchStreamProvider for ChannelReader<P>

where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

fn flush(&mut self)

This method is called by the BatchStream if an invalid span batch is found. In the case of an invalid span batch, the associated channel must be flushed.

See: https://specs.optimism.io/protocol/holocene/derivation.html#span-batches

SAFETY: Only called post-holocene activation.

fn next_batch<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = PipelineResult<Batch>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the next Batch in the BatchStream stage.

impl<P> Debug for ChannelReader<P>

where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug + Debug,

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

Formats the value using the given formatter.

impl<P> OriginAdvancer for ChannelReader<P>

where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

fn advance_origin<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = PipelineResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Advances the internal state of the lowest stage to the next l1 origin. This method is the equivalent of the reference implementation advance_l1_block.

impl<P> OriginProvider for ChannelReader<P>

where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,

fn origin(&self) -> Option<BlockInfo>

Returns the optional L1 BlockInfo origin.

impl<P> SignalReceiver for ChannelReader<P>

where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug + Send,

fn signal<'life0, 'async_trait>( &'life0 mut self, signal: Signal, ) -> Pin<Box<dyn Future<Output = PipelineResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Receives a signal from the driver.