Struct ChannelOut

pub struct ChannelOut<'a, C>
where
    C: ChannelCompressor,
{
    pub id: [u8; 16],
    pub config: &'a RollupConfig,
    pub rlp_length: u64,
    pub closed: bool,
    pub frame_number: u16,
    pub compressor: C,
}

Available on crate feature protocol only.

ChannelOut constructs a channel from compressed, encoded batch data.

Fields

id: [u8; 16]

The unique identifier for the channel.

config: &'a RollupConfig

A reference to the RollupConfig used to check the max RLP bytes per channel when encoding and accepting the

rlp_length: u64

The rlp length of the channel.

closed: bool

Whether the channel is closed.

frame_number: u16

The frame number.

compressor: C

The compressor.

Implementations

impl<'a, C> ChannelOut<'a, C>

where C: ChannelCompressor,

pub const fn new( id: [u8; 16], config: &'a RollupConfig, compressor: C, ) -> ChannelOut<'a, C>

Creates a new ChannelOut with the given ChannelId.

pub fn reset(&mut self)

Resets the ChannelOut to its initial state.

pub fn add_batch(&mut self, batch: Batch) -> Result<(), ChannelOutError>

Accepts the given crate::Batch data into the ChannelOut, compressing it into frames.

pub const fn input_bytes(&self) -> u64

Returns the total amount of rlp-encoded input bytes.

pub fn ready_bytes(&self) -> usize

Returns the number of bytes ready to be output to a frame.

pub fn flush(&mut self) -> Result<(), ChannelOutError>

Flush the internal compressor.

pub fn close(&mut self)

Closes the channel if not already closed.

pub fn output_frame( &mut self, max_size: usize, ) -> Result<Frame, ChannelOutError>

Outputs a Frame from the ChannelOut.