Struct Packet 

pub struct Packet<'a> {
    pub sync: u8,
    pub protocol: u8,
    pub packet_type: u8,
    pub payload: &'a [u8],
}

A protocol packet, borrowed from a buffer.

Fields

sync: u8

Sync counter. Wraps mod 256.

protocol: u8

Protocol id. Only the low 4 bits are used; values >15 will fail to encode.

packet_type: u8

Packet type within the protocol. Only the low 4 bits are used.

payload: &'a [u8]

Payload bytes. May be empty.

Implementations

impl<'a> Packet<'a>

pub fn new( sync: u8, protocol: u8, packet_type: u8, payload: &'a [u8], ) -> Result<Self, EncodeError>

Construct a packet, validating that the protocol id, packet type, and payload length all fit on the wire.

pub fn wire_len(&self) -> usize

Total bytes this packet occupies on the wire.

Trait Implementations

impl<'a> Clone for Packet<'a>

fn clone(&self) -> Packet<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Packet<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Packet<'a>

fn eq(&self, other: &Packet<'a>) -> 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<'a> Eq for Packet<'a>

impl<'a> StructuralPartialEq for Packet<'a>