Minecraft v0.1.0 Minecraft.Packet View Source

Base serialization and deserialization routines for packets.

Link to this section Summary

Decodes a string

Decodes a variable-size integer

Decodes a variable-size long

Given a raw binary packet, deserializes it into a Packet struct

Encodes a string

Encodes a variable-size integer

Serializes a packet into binary data

Serializes a packet binary into the standard packet format

varint()

varint() :: -2_147_483_648..2_147_483_647

varlong()

varlong() :: -9_223_372_036_854_775_808..9_223_372_036_854_775_807

decode_string(data)

decode_string(binary()) :: {decoded :: binary(), rest :: binary()}

Decodes a string.

decode_varint(data)

decode_varint(binary()) ::
  {decoded :: varint(), rest :: binary()} | {:error, :too_long | :too_short}

Decodes a variable-size integer.

decode_varlong(data)

decode_varlong(binary()) ::
  {decoded :: varlong(), rest :: binary()} | {:error, :too_long | :too_short}

Decodes a variable-size long.

deserialize(data, state, type \\ :client)

deserialize(binary(), state :: atom(), type :: :client | :server) ::
  {packet :: term(), rest :: binary()} | {:error, :invalid_packet}

Given a raw binary packet, deserializes it into a Packet struct.

encode_string(string)

encode_string(binary()) :: binary()

Encodes a string.

encode_varint(value)

encode_varint(varint()) :: binary() | {:error, :too_large}

Encodes a variable-size integer.

serialize(request)

serialize(packet :: struct()) :: {:ok, binary()} | {:error, term()}

Serializes a packet into binary data.

serialize(packet_id, packet_binary)

serialize(packet_id :: integer(), binary()) ::
  {:ok, binary()} | {:error, term()}

Serializes a packet binary into the standard packet format:

Field	Type	Description
Length	VarInt	Length of packet data + length of the packet ID
Packet ID	VarInt
Data	Binary	The serialized packet data