Enum IdSet 

pub enum IdSet {
    Tag(Identifier),
    Inline(Vec<i32>),
}

A set of registry IDs represented inline or by reference to a tag.

The registry itself is implied by the enclosing packet or field. The Minecraft protocol ID Set wire representation starts with a VarInt type value:

• 0 is followed by an Identifier naming a registry tag;
• a positive value n is followed by n - 1 registry IDs encoded as VarInts.

VarInt(0) + Identifier(tag_name)
VarInt(ids.len() + 1) + VarInt(ids[0]) + ... + VarInt(ids[len - 1])

An empty inline set therefore uses type value 1. Registry IDs must be non-negative, and an inline set may contain at most i32::MAX - 1 IDs.

Examples

use mcproto_types::{TypeCodec, basic::Identifier};
use mcproto_types::contextual::IdSet;

let inline = IdSet::inline(vec![3, 7]);
let mut encoded = Vec::new();
inline.encode(&mut encoded)?;
assert_eq!(encoded, [0x03, 0x03, 0x07]);

let mut input = encoded.as_slice();
assert_eq!(IdSet::decode(&mut input)?, inline);

let tagged = IdSet::tag(Identifier::new("minecraft:logs")?);
assert!(tagged.is_tag());

Variants

Tag(Identifier)

A named set of IDs defined by a registry tag.

Inline(Vec<i32>)

An ad-hoc set of zero-based registry IDs enumerated inline.

Implementations

impl IdSet

pub const fn tag(tag_name: Identifier) -> Self

Creates an ID set that refers to a registry tag.

pub const fn inline(ids: Vec<i32>) -> Self

Creates an ID set containing inline registry IDs.

pub const fn is_tag(&self) -> bool

Returns whether this set refers to a registry tag.

pub const fn is_inline(&self) -> bool

Returns whether this set enumerates registry IDs inline.

pub const fn tag_name(&self) -> Option<&Identifier>

Returns the registry tag name, if this is a tag reference.

pub const fn ids(&self) -> Option<&[i32]>

Returns the inline registry IDs, if present.

pub fn into_tag(self) -> Option<Identifier>

Extracts the registry tag name, if this is a tag reference.

pub fn into_ids(self) -> Option<Vec<i32>>

Extracts the inline registry IDs, if present.

Trait Implementations

impl Clone for IdSet

fn clone(&self) -> IdSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdSet

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

Formats the value using the given formatter.

impl Eq for IdSet

impl From<Identifier> for IdSet

fn from(tag_name: Identifier) -> Self

Converts to this type from the input type.

impl From<Vec<i32>> for IdSet

fn from(ids: Vec<i32>) -> Self

Converts to this type from the input type.

impl Hash for IdSet

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 IdSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IdSet

impl TypeCodec for IdSet

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.