Struct Frame

pub struct Frame {
    pub flags: u8,
    pub size: u16,
    pub reliable_index: Option<u32>,
    pub sequence_index: Option<u32>,
    pub order_index: Option<u32>,
    pub order_channel: Option<u8>,
    pub fragment_meta: Option<FragmentMeta>,
    pub reliability: Reliability,
    pub body: Vec<u8>,
}

An individual data frame, these are constructed from a payload.

Fields

flags: u8

The flags for this frame, the first 3 bits are reserved for the reliability while the 4th bit is used to represent if this is a fragment.

size: u16

The length of the body of the frame. This is sized to 24 bits internally, so any number here must be within that range.

reliable_index: Option<u32>

The Reliable index of the frame (if reliable)

sequence_index: Option<u32>

The sequenced index of the frame (if sequenced) This is used to determine the position in frame list.

order_index: Option<u32>

The order index of the frame (if ordered) This is used to determine the position in frame list, This is different from the sequence index in that it is used more to sequence packets in a specific manner.

order_channel: Option<u8>

The order channel of the frame (if ordered) This is used to store order information for the frame.

fragment_meta: Option<FragmentMeta>

The information for fragmentation (if the frame is split into parts) This is used to determine how to reassemble the frame.

reliability: Reliability

The reliability of this frame, this is essentially used to save frames and send them back if they are lost. Otherwise, the frame is sent unreliably.

body: Vec<u8>

The body of the frame, this is the payload of the frame.

Implementations

impl Frame

pub fn init() -> Self

Initializes a new empty frame that is Unreliable. This is usually used to inject data into.

pub fn new(reliability: Reliability, body: Option<&[u8]>) -> Self

Initializes a new frame with the given reliability.

pub fn is_fragmented(&self) -> bool

Whether or not the frame is fragmented.

pub fn is_sequenced(&self) -> bool

Whether or not the frame is sequenced and reliable.

pub fn with_meta(self, meta: FragmentMeta) -> Self

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 Reader<Frame> for Frame

fn read(buf: &mut ByteReader) -> Result<Frame, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Writer for Frame

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.