Struct naia_shared::StandardHeader

pub struct StandardHeader { /* fields omitted */ }

This header provides reliability information.

Implementations

impl StandardHeader

pub fn new(
    p_type: PacketType,
    local_packet_index: u16,
    last_remote_packet_index: u16,
    bit_field: u32,
    host_tick: u16,
    last_received_tick: u16
) -> StandardHeader

When we compose packet headers, the local sequence becomes the sequence number of the packet, and the remote sequence becomes the ack. The ack bitfield is calculated by looking into a queue of up to 33 packets, containing sequence numbers in the range [remote sequence - 32, remote sequence]. We set bit n (in [1,32]) in ack bits to 1 if the sequence number remote sequence - n is in the received queue.

pub const fn bytes_number() -> usize

Returns the number of bytes in the header

pub fn packet_type(&self) -> PacketType

Returns the packet type indicated by the header

pub fn local_packet_index(&self) -> u16

Returns the sequence number from this packet.

pub fn ack_field(&self) -> u32

Returns bit field of all last 32 acknowledged packages.

pub fn last_remote_packet_index(&self) -> u16

Returns last acknowledged sequence number.

pub fn host_tick(&self) -> u16

Returns the current tick of the sending Host

pub fn last_received_tick(&self) -> u16

Returns the last received tick from the remote Host

pub fn write(&self, buffer: &mut Vec<u8>)

Writes the header to an outgoing byte buffer

pub fn read(msg: &[u8]) -> (Self, Box<[u8]>)

Reads the header from an incoming byte slice

Trait Implementations

impl Clone for StandardHeader

pub fn clone(&self) -> StandardHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StandardHeader

impl Debug for StandardHeader

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

Formats the value using the given formatter.