Struct blaze_pk::PacketHeader

pub struct PacketHeader {
    pub component: u16,
    pub command: u16,
    pub error: u16,
    pub ty: PacketType,
    pub id: u16,
}

Structure of packet header which comes before the packet content and describes it.

Fields

component: u16

The component of this packet

command: u16

The command of this packet

error: u16

A possible error this packet contains (zero is none)

ty: PacketType

The type of this packet

id: u16

The unique ID of this packet (Notify packets this is just zero)

Implementations

impl PacketHeader

pub fn path_matches(&self, other: &PacketHeader) -> bool

Checks if the component and command of this packet header matches that of the other packet header

pub fn encode_bytes(&self, length: usize) -> Vec<u8>

Encodes a packet header with the provided length value

pub fn read<R: Read>(input: &mut R) -> PacketResult<(PacketHeader, usize)>where
    Self: Sized,

Reads a packet header from the provided input as well as the length of the content

Trait Implementations

impl Clone for PacketHeader

fn clone(&self) -> PacketHeader

Returns a copy 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<PacketHeader> for PacketHeader

fn eq(&self, other: &PacketHeader) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PacketHeader

impl StructuralEq for PacketHeader

impl StructuralPartialEq for PacketHeader