Enum InvalidEncodingReason 

#[non_exhaustive]
pub enum InvalidEncodingReason {
    TooLong {
        max_bytes: usize,
    },
    ValueOutOfRange {
        terminal_byte: u8,
        allowed_mask: u8,
    },
    InvalidBooleanValue {
        value: u8,
    },
    StringTooLong {
        max_bytes: usize,
    },
    TooManyUtf16CodeUnits {
        max_code_units: usize,
    },
    NegativeLength {
        value: i32,
    },
    LengthOutOfRange {
        max: usize,
        actual: usize,
    },
    InvalidEnumValue {
        value: i128,
    },
    EnumDiscriminantOutOfRange {
        value: i128,
    },
    LpVec3ScaleOutOfRange {
        scale_factor: u64,
        max: u64,
    },
    InvalidRegistryId {
        value: i32,
        max: i32,
    },
    InvalidEntityMetadataIndex {
        index: u8,
    },
    DuplicateEntityMetadataIndex {
        index: u8,
    },
    InvalidOptionalVarInt {
        value: i32,
    },
    InvalidIdOrSelector {
        value: i32,
    },
    InvalidIdSetType {
        value: i32,
    },
    InvalidSlotCount {
        value: i64,
    },
    InvalidFixedBitSetLength {
        expected: usize,
        actual: usize,
    },
    OptionalValueMismatch {
        context_present: bool,
        value_present: bool,
    },
    MissingContext {
        required: ContextRequirement,
    },
    ArrayLengthMismatch {
        expected: usize,
        actual: usize,
    },
    InvalidUtf8 {
        valid_up_to: usize,
        error_len: Option<usize>,
    },
    InvalidIdentifier,
    InvalidNbt,
    InvalidJson,
    InvalidTextComponentRootTag {
        tag: u8,
    },
}

Describes why encoded protocol data is invalid.

Some reasons describe a mismatch between a codec and the context supplied by its enclosing packet.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TooLong

The encoding exceeds the maximum allowed length in bytes.

Fields

max_bytes: usize

The maximum number of bytes permitted for this encoding.

ValueOutOfRange

The terminal byte of the encoding contains bits outside the allowed mask.

Fields

terminal_byte: u8

The final byte that contains disallowed bits.

allowed_mask: u8

A mask whose set bits identify the permitted bits in the final byte.

InvalidBooleanValue

The boolean value is invalid (not 0x00 or 0x01).

Fields

value: u8

The byte read instead of the permitted 0x00 or 0x01.

StringTooLong

The string exceeds the maximum allowed length in bytes when encoded in UTF-8.

Fields

max_bytes: usize

The maximum permitted size of the UTF-8 payload, excluding its VarInt length prefix.

TooManyUtf16CodeUnits

The string exceeds the maximum allowed length in UTF-16 code units.

Fields

max_code_units: usize

The maximum permitted number of UTF-16 code units.

NegativeLength

The length of the data is negative, which is invalid.

Fields

value: i32

The negative length decoded from the data.

LengthOutOfRange

The length cannot be represented by the encoded length prefix.

Fields

max: usize

The greatest length representable by the prefix.

actual: usize

The length that was to be encoded.

InvalidEnumValue

A decoded numeric enum value does not name a declared variant.

Fields

value: i128

The numeric value decoded from the enum’s wire representation.

EnumDiscriminantOutOfRange

An enum variant’s numeric discriminant cannot be represented on the wire.

Fields

value: i128

The numeric discriminant that cannot be encoded.

LpVec3ScaleOutOfRange

An LpVec3 scale factor exceeds the 34-bit wire representation.

Fields

scale_factor: u64

The rounded-up scale factor that was to be encoded.

max: u64

The greatest scale factor representable by the format.

InvalidRegistryId

A registry ID cannot be represented by the ID or X wire format.

Fields

value: i32

The invalid registry ID.

max: i32

The greatest registry ID supported by the enclosing wire format.

InvalidEntityMetadataIndex

An entity metadata entry uses the reserved 0xff terminator as its index.

Fields

index: u8

The invalid entry index.

DuplicateEntityMetadataIndex

An entity metadata sequence contains the same index more than once.

Fields

index: u8

The repeated entry index.

InvalidOptionalVarInt

An Optional VarInt selector cannot be mapped to a present value.

Fields

value: i32

The invalid selector or in-memory value.

InvalidIdOrSelector

The decoded ID or X selector is negative.

Fields

value: i32

The invalid selector value read from the wire.

InvalidIdSetType

The decoded ID Set type value is negative.

Fields

value: i32

The invalid type value read from the wire.

InvalidSlotCount

A non-empty item stack count must fit a positive VarInt.

Fields

value: i64

The invalid count.

InvalidFixedBitSetLength

The packed byte array does not have the required fixed length.

Fields

expected: usize

The expected number of packed bytes.

actual: usize

The actual number of packed bytes.

OptionalValueMismatch

An optional value does not agree with its externally supplied context.

Fields

context_present: bool

Whether the context says that the value is present on the wire.

value_present: bool

Whether the value held by the wrapper is present in memory.

MissingContext

A contextual codec was used without the information it requires.

Fields

required: ContextRequirement

The kind of information that was not supplied.

ArrayLengthMismatch

The number of array values does not match the contextual length.

Fields

expected: usize

The element count required by the context.

actual: usize

The element count held by the array.

InvalidUtf8

The data contains an invalid UTF-8 sequence.

Fields

valid_up_to: usize

The byte offset in the UTF-8 payload up to which the data is valid.

error_len: Option<usize>

The length of the invalid sequence, or None if the input ends in an incomplete sequence.

InvalidIdentifier

The data is not a valid Minecraft identifier.

InvalidNbt

The data is not valid NBT (Named Binary Tag) data.

InvalidJson

The data is not valid JSON.

InvalidTextComponentRootTag

The root tag of a text component is invalid (not TAG_String or TAG_Compound).

Fields

tag: u8

The unsupported NBT root tag identifier.

Trait Implementations

impl Clone for InvalidEncodingReason

fn clone(&self) -> InvalidEncodingReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InvalidEncodingReason

impl Debug for InvalidEncodingReason

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

Formats the value using the given formatter.

impl Display for InvalidEncodingReason

Formats an invalid encoding reason as a diagnostic message.

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

Formats the value using the given formatter.

impl Eq for InvalidEncodingReason

impl Hash for InvalidEncodingReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InvalidEncodingReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InvalidEncodingReason