kona_derive_alloy::prelude

Struct ChannelReader

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

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§

Source§

impl<P> ChannelReader<P>
where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,

Source

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

Create a new ChannelReader stage.

Source

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§

Source§

impl<P> BatchStreamProvider for ChannelReader<P>
where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

Source§

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.

Source§

fn next_batch<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Batch, PipelineErrorKind>> + Send + 'async_trait>>
where 'life0: 'async_trait, ChannelReader<P>: 'async_trait,

Returns the next Batch in the BatchStream stage.
Source§

impl<P> Debug for ChannelReader<P>
where P: Debug + ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<P> OriginAdvancer for ChannelReader<P>
where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

Source§

fn advance_origin<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), PipelineErrorKind>> + Send + 'async_trait>>
where 'life0: 'async_trait, ChannelReader<P>: '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.
Source§

impl<P> OriginProvider for ChannelReader<P>
where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,

Source§

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

Returns the optional L1 BlockInfo origin.
Source§

impl<P> SignalReceiver for ChannelReader<P>
where P: ChannelReaderProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug + Send,

Source§

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

Receives a signal from the driver.

Auto Trait Implementations§

§

impl<P> Freeze for ChannelReader<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for ChannelReader<P>
where P: RefUnwindSafe,

§

impl<P> Send for ChannelReader<P>
where P: Send,

§

impl<P> Sync for ChannelReader<P>
where P: Sync,

§

impl<P> Unpin for ChannelReader<P>
where P: Unpin,

§

impl<P> UnwindSafe for ChannelReader<P>
where P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T