Struct ClientPacket 

#[non_exhaustive]
pub struct ClientPacket {
    pub id: Identifier,
    pub custom_payload: Option<ClientPayload>,
}

The metadata of a server play packet observed by Hooks::client_packet.

Fields beyond the type id are exposed only for custom payloads. This is plain mod API data, not the game’s decoded protocol enum.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Identifier

The protocol type, such as minecraft:ping or minecraft:custom_payload. An id outside the protocol’s packet table is reported as horizon:unknown.

custom_payload: Option<ClientPayload>

The channel and bytes of a custom payload; None for other packet types.

Implementations

impl ClientPacket

pub fn new( id: Identifier, custom_payload: Option<ClientPayload>, ) -> ClientPacket

Construct packet metadata with an optional custom payload.

Trait Implementations

impl Clone for ClientPacket

fn clone(&self) -> ClientPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientPacket

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

Formats the value using the given formatter.

impl PartialEq for ClientPacket

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientPacket

impl Wire for ClientPacket

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<ClientPacket, WireError>

Decodes one value, leaving any following bytes for the caller.