Struct PacketHeader 

pub struct PacketHeader {
    pub version: u8,
    pub flags: u8,
    pub kind: PacketKind,
    pub sequence: u32,
    pub ack: u32,
    pub ack_bits: u32,
    pub payload_len: u16,
}

Fixed-size header that precedes every packet on the wire.

Wire layout (20 bytes):

[0..4]   magic       PEMP
[4]      version     u8
[5]      flags       u8  (bits: 0-1 compression, 2 reliable, 3 ordered, 4 fragmented, 5-7 reserved)
[6..8]   kind        u16 big-endian
[8..12]  sequence    u32 big-endian
[12..16] ack         u32 big-endian
[16..20] ack_bits    u32 big-endian
[20..22] payload_len u16 big-endian

Total header: 22 bytes.

Fields

version: u8

flags: u8

kind: PacketKind

sequence: u32

ack: u32

ack_bits: u32

payload_len: u16

Implementations

impl PacketHeader

pub const SIZE: usize = 22

pub const FLAG_RELIABLE: u8 = 0b0000_0100

Flag bit: payload is reliable (must be acked).

pub const FLAG_ORDERED: u8 = 0b0000_1000

Flag bit: channel is ordered.

pub const FLAG_FRAGMENTED: u8 = 0b0001_0000

Flag bit: packet is a fragment of a larger message.

pub fn compression(&self) -> Result<CompressionHint, ProtocolError>

Extract compression hint from flags bits 0-1.

pub fn is_reliable(&self) -> bool

pub fn is_ordered(&self) -> bool

pub fn is_fragmented(&self) -> bool

Trait Implementations

impl Clone for PacketHeader

fn clone(&self) -> PacketHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PacketHeader

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

Formats the value using the given formatter.

impl PartialEq for PacketHeader

fn eq(&self, other: &PacketHeader) -> 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 PacketHeader

impl StructuralPartialEq for PacketHeader