Enum IdOr 

pub enum IdOr<T> {
    Id(i32),
    Inline(T),
}

A protocol value represented either by registry ID or by an inline T.

The Minecraft protocol ID or X wire representation begins with a VarInt selector:

• 0 means that a value of type T follows inline;
• a positive value n refers to registry ID n - 1 and has no inline payload.

VarInt(0) + T              // Inline value
VarInt(registry_id + 1)    // Registry reference

Registry IDs held by this type are the actual zero-based IDs, not their incremented wire selectors. Valid IDs range from 0 through i32::MAX - 1. The registry itself is implied by the enclosing packet or field definition; it does not need to be stored in Context because it does not affect this value’s byte layout.

Examples

use mcproto_types::{TypeCodec, basic::UnsignedByte};
use mcproto_types::contextual::IdOr;

let inline = IdOr::inline(UnsignedByte(0xab));
let mut encoded = Vec::new();
inline.encode(&mut encoded)?;
assert_eq!(encoded, [0x00, 0xab]);

let mut input = encoded.as_slice();
assert_eq!(IdOr::<UnsignedByte>::decode(&mut input)?, inline);

let reference = IdOr::<UnsignedByte>::id(4);
let mut encoded = Vec::new();
reference.encode(&mut encoded)?;
assert_eq!(encoded, [0x05]);

Variants

Id(i32)

A zero-based ID in the registry implied by the enclosing field.

Inline(T)

A complete value encoded inline after a zero selector.

Implementations

impl<T> IdOr<T>

pub const fn id(id: i32) -> Self

Creates a registry reference from its actual zero-based ID.

pub const fn inline(value: T) -> Self

Creates an inline value.

pub const fn is_id(&self) -> bool

Returns whether this value is a registry reference.

pub const fn is_inline(&self) -> bool

Returns whether this value is defined inline.

pub const fn registry_id(&self) -> Option<i32>

Returns the zero-based registry ID, if this is a reference.

pub const fn inline_value(&self) -> Option<&T>

Returns the inline value by reference, if present.

pub const fn as_ref(&self) -> IdOr<&T>

Borrows the inline value while preserving registry references.

pub fn into_inline(self) -> Option<T>

Extracts the inline value, if present.

Trait Implementations

impl<T: Clone> Clone for IdOr<T>

fn clone(&self) -> IdOr<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IdOr<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for IdOr<T>

impl<T> From<T> for IdOr<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for IdOr<T>

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<T: PartialEq> PartialEq for IdOr<T>

fn eq(&self, other: &IdOr<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for IdOr<T>

impl<T> TypeCodec for IdOr<T>

where T: TypeCodec,

fn encode(&self, writer: &mut impl Write) -> Result<(), CodecError>

Encodes this value to the writer.

fn decode(reader: &mut impl Read) -> Result<Self, CodecError>

Decodes this value from the reader.