Struct Channel

pub struct Channel { /* private fields */ }

A Channel is a set of batches that are split into at least one, but possibly multiple frames.

Frames are allowed to be ingested out of order. Each frame is ingested one by one. Once a frame with closed is added to the channel, the channel may mark itself as ready for reading once all intervening frames have been added

Implementations

impl Channel

pub fn new(id: ChannelId, open_block: BlockInfo) -> Self

Create a new Channel with the given ChannelId and BlockInfo.

pub const fn id(&self) -> ChannelId

Returns the current ChannelId for the channel.

pub fn len(&self) -> usize

Returns the number of frames ingested.

pub fn is_empty(&self) -> bool

Returns if the channel is empty.

pub fn add_frame( &mut self, frame: Frame, l1_inclusion_block: BlockInfo, ) -> Result<(), ChannelError>

Add a frame to the channel.

Takes

• frame: The frame to add to the channel
• l1_inclusion_block: The block that the frame was included in

Returns

• Ok(()): If the frame was successfully buffered
• Err(_): If the frame was invalid

pub const fn open_block_number(&self) -> u64

Returns the block number of the L1 block that contained the first Frame in this channel.

pub const fn size(&self) -> usize

Returns the estimated size of the channel including Frame overhead.

pub fn is_ready(&self) -> bool

Returns true if the channel is ready to be read.

pub fn frame_data(&self) -> Option<Bytes>

Returns all of the channel’s Frames concatenated together.

Returns

• Some(Bytes): The concatenated frame data
• None: If the channel is missing frames

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl Default for Channel

fn default() -> Channel

Returns the “default value” for a type.