Struct Packet

pub struct Packet {
    length: usize,
    id: VarInt,
    data: BytesMut,
    payload: BytesMut,
    name: Option<String>,
}

An abstraction for a Minecraft packet.

Structure of a normal uncompressed Packet:

Length (VarInt): Length of Packet ID + Data P): An ID each packet has Data (Byte Aacket ID (VarIntrray): Actual data bytes

Fields

length: usize

Length of id + data

id: VarInt

An ID that each Packet has, varint-decoded.

data: BytesMut

The raw bytes making the packet. (so it contains ALL the packet, Length, Packet ID and the data bytes)

payload: BytesMut

The raw bytes making the PAYLOAD of the packet. (so this slice does not contain the length and acket ID)

name: Option<String>

For debugging purposes, the type of the packet, like ‘Handshake (handshaking)’.

Implementations

impl Packet

pub fn new<T: AsRef<[u8]>>(data: T) -> Result<Self, PacketError>

Initializes a new Packet by parsing the data buffer.

pub fn get_full_packet(&self) -> &[u8]

This is the WHOLE packet.

pub fn get_payload(&self) -> &[u8]

This is the PAYLOAD. So the bytes except the Packet Length and the Packet ID.

pub fn set_name(&mut self, name: &str)

Sets the name of the current packet.

pub fn get_name(&self) -> &Option<String>

Returns the name of the current packet.

pub fn get_id(&self) -> &VarInt

Returns a reference to the packet ID VarInt.

pub fn get_length(&self) -> usize

Returns the Packet length attribute. From protocol.

pub fn len_payload(&self) -> usize

Returns the number of bytes in the payload.

pub fn len(&self) -> usize

Returns the number of bytes in the packet. To be clear, this is the length of the received TCP packet.

fn parse_packet(data: &[u8]) -> Result<(usize, VarInt, &[u8]), PacketError>

Tries to parse raw bytes and return in order: (Packet Length, Packet ID, Packet payload bytes)

Trait Implementations

impl AsRef<[u8]> for Packet

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

For :? and :#? Debug displays the all the BYTES.

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

Formats the value using the given formatter.

impl Default for Packet

Allows making a Packet object with defaults. Usage:

let packet = Packet::default();

fn default() -> Self

Returns the “default value” for a type.

impl Display for Packet

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

Formats the value using the given formatter.

impl PartialEq for Packet

fn eq(&self, other: &Packet) -> 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 TryFrom<Packet> for FinishConfiguration

type Error = PacketError

The type returned in the event of a conversion error.

fn try_from(value: Packet) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Packet> for Handshake

type Error = PacketError

The type returned in the event of a conversion error.

fn try_from(value: Packet) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Packet> for LoginAcknowledged

type Error = PacketError

The type returned in the event of a conversion error.

fn try_from(value: Packet) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Packet> for LoginStart

type Error = PacketError

The type returned in the event of a conversion error.

fn try_from(value: Packet) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Packet> for ServerboundKnownPacks

type Error = PacketError

The type returned in the event of a conversion error.

fn try_from(value: Packet) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Packet

impl StructuralPartialEq for Packet