Enum Reliability

#[repr(u8)]
pub enum Reliability {
    Unreliable = 0,
    UnreliableSeq = 1,
    Reliable = 2,
    ReliableOrd = 3,
    ReliableSeq = 4,
    UnreliableAck = 5,
    ReliableAck = 6,
    ReliableOrdAck = 7,
}

The RakNet Reliabilty of a packet.

This is a bit flag encoded within each Frame that determines how the packet should be handled. As of writing the following reliability types are supported:

• Unreliable
• UnreliableSeq
• Reliable
• ReliableOrd
• ReliableSeq

Variants

Unreliable = 0

Unreliable (with no ack)

UnreliableSeq = 1

Unreliable with a sequence

Reliable = 2

Reliable

ReliableOrd = 3

ReliableSeq = 4

Reliably sequenced AND ordered

UnreliableAck = 5

never used over the wire

ReliableAck = 6

never used over the wire

ReliableOrdAck = 7

never used over the wire

Implementations

impl Reliability

pub fn from_flags(flags: u8) -> Self

Creates a new Reliability from the given flags. This is used internally to decode the reliability from the given bit flags.

pub fn to_flags(&self) -> u8

Converts the Reliability into a bit flag. This is useful for encoding the reliability into a packet.

pub fn is_ordered(&self) -> bool

This method checks whether the reliability is ordered, meaning that the packets are either:

• ReliableOrd
• ReliableOrdAck
• UnreliableSeq

pub fn is_reliable(&self) -> bool

Verifies whether or not the reliabilty is reliable, meaning that the packets are either:

• Reliable
• ReliableOrd
• ReliableSeq
• ReliableAck

Other reliabilities are not reliable, and will return false.

pub fn is_unreliable(&self) -> bool

Verifies whether or not the reliabilty is unreliable, meaning that the packets are either:

• Unreliable
• UnreliableSeq
• UnreliableAck

Other reliabilities are not unreliable, and will return false.

pub fn is_sequenced(&self) -> bool

Verifies whether or not the reliabilty is sequenced, meaning that the packets are either:

• UnreliableSeq
• ReliableSeq

Other reliabilities are not sequenced, and will return false.

What is a sequenced packet?

A sequenced packet is a packet with an index that is incremented after each packet. RakNet uses this internally to discard packets that are sent out of sequence, accepting only the latest packet.

pub fn is_sequenced_or_ordered(&self) -> bool

Verifies whether or not the reliabilty is sequenced or ordered. This function is a combination of Reliability::is_sequenced and Reliability::is_ordered, combined into one signature.

pub fn is_ack(&self) -> bool

Verifies that the reliability is an ack (Ack). This is primarily used internally to determine whether or not to send an ack.

Trait Implementations

impl Clone for Reliability

fn clone(&self) -> Reliability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reliability

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

Formats the value using the given formatter.

impl Copy for Reliability