Struct Frame

pub struct Frame {
    pub id: ChannelId,
    pub number: u16,
    pub data: Vec<u8>,
    pub is_last: bool,
}

A channel frame is a segment of a channel’s data.

Encoding frame = channel_id ++ frame_number ++ frame_data_length ++ frame_data ++ is_last

• channel_id = bytes16
• frame_number = uint16
• frame_data_length = uint32
• frame_data = bytes
• is_last = bool

Fields

id: ChannelId

The unique idetifier for the frame.

number: u16

The number of the frame.

data: Vec<u8>

The data within the frame.

is_last: bool

Whether or not the frame is the last in the sequence.

Implementations

impl Frame

pub const fn new( id: ChannelId, number: u16, data: Vec<u8>, is_last: bool, ) -> Self

Creates a new Frame.

pub fn encode(&self) -> Vec<u8>

Encode the frame into a byte vector.

pub fn decode(encoded: &[u8]) -> Result<(usize, Self), FrameDecodingError>

Decode a frame from a byte vector.

pub fn parse_frame( data: &[u8], start: usize, ) -> Result<(usize, Self), FrameDecodingError>

Parses a single frame from the given data at the given starting position, returning the frame and the number of bytes consumed.

pub fn parse_frames(encoded: &[u8]) -> Result<Vec<Self>, FrameParseError>

Parse the on chain serialization of frame(s) in an L1 transaction. Currently only version 0 of the serialization format is supported. All frames must be parsed without error and there must not be any left over data and there must be at least one frame.

Frames are stored in L1 transactions with the following format:

• data = DerivationVersion0 ++ Frame(s) Where there is one or more frames concatenated together.

pub fn size(&self) -> usize

Calculates the size of the frame + overhead for storing the frame. The sum of the frame size of each frame in a channel determines the channel’s size. The sum of the channel sizes is used for pruning & compared against the max channel bank size.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Frame

impl StructuralPartialEq for Frame