Struct NbtCompound 

pub struct NbtCompound { /* private fields */ }

An unordered collection of named NBT tags.

NbtCompound is the primary structured data container in NBT. It maps string names to typed values and is used for virtually all complex game data: items, entities, block entities, player data, level data.

The wire format encodes each entry as: tag type byte + name (u16-prefixed UTF-8) + payload, terminated by an End tag (type 0, no name, no payload).

Uses IndexMap to preserve insertion order (required for deterministic wire encoding) while providing O(1) lookups instead of O(n) scans.

Implementations

impl NbtCompound

pub fn new() -> Self

Creates a new empty compound.

pub fn insert(&mut self, name: impl Into<String>, tag: NbtTag)

Inserts a named tag into the compound.

If a tag with the same name already exists, it is replaced. The insertion order of new keys is preserved.

pub fn get(&self, name: &str) -> Option<&NbtTag>

Returns a reference to the tag with the given name, if it exists.

pub fn iter(&self) -> impl Iterator<Item = (&str, &NbtTag)>

Returns an iterator over all (name, tag) pairs in insertion order.

pub fn len(&self) -> usize

Returns the number of entries in the compound.

pub fn is_empty(&self) -> bool

Returns true if the compound contains no entries.

pub fn contains_key(&self, name: &str) -> bool

Returns true if the compound contains a tag with the given name.

Trait Implementations

impl Clone for NbtCompound

fn clone(&self) -> NbtCompound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NbtCompound

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

Formats the value using the given formatter.

impl Decode for NbtCompound

Decodes an NbtCompound from network NBT format.

Since Minecraft 1.20.3, network NBT uses a simplified root format: a compound tag type byte (0x0A) followed directly by the compound payload (no root tag name). This differs from the traditional NBT format which includes a root tag name.

Fails if the root tag type is not Compound (0x0A).

fn decode(buf: &mut &[u8]) -> Result<Self>

Reads the compound type byte, then decodes the compound payload.

Fails with Error::Nbt if the root type is not Compound, or with other errors if the payload is malformed.

impl Default for NbtCompound

fn default() -> Self

Returns the “default value” for a type.

impl Encode for NbtCompound

Encodes an NbtCompound as a network NBT root compound.

Since Minecraft 1.20.3, network NBT uses a simplified root format: a compound tag type byte (0x0A) followed directly by the compound payload (no root tag name). This differs from the traditional NBT format which includes a root tag name after the type byte.

This encoder produces the network NBT format used in modern protocol packets (chat components, item stacks, registry data).

fn encode(&self, buf: &mut Vec<u8>) -> Result<()>

Writes the compound type byte (0x0A) followed by the compound payload.

impl EncodedSize for NbtCompound

Computes the wire size of a network NBT root compound.

Includes the compound type byte (1) plus the compound payload size (entries + End tag).

fn encoded_size(&self) -> usize

Returns 1 (type byte) + payload size.

impl PartialEq for NbtCompound

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NbtCompound