Struct DataComponentPatch 

pub struct DataComponentPatch {
    entries: FxHashMap<Identifier, ComponentPatchEntry>,
}

A patch representing modifications to a DataComponentMap.

Stores differences from a prototype:

• Components that are added or overridden (Set)
• Components that are explicitly removed (Removed)

Fields

entries: FxHashMap<Identifier, ComponentPatchEntry>

Implementations

impl DataComponentPatch

pub fn new() -> Self

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn set<T: Component>(&mut self, component: DataComponentType<T>, value: T)

Sets a component value in the patch.

pub fn set_raw(&mut self, key: Identifier, data: ComponentData) -> bool

Sets raw component data (for plugin use).

Returns true if the data was set successfully, false if the data type doesn’t match the registered component type (validation failed).

This prevents plugins from setting invalid types on vanilla components.

pub fn remove<T>(&mut self, component: DataComponentType<T>)

Marks a component as removed.

pub fn clear<T>(&mut self, component: DataComponentType<T>)

Clears any patch entry for a component.

pub fn get_entry(&self, key: &Identifier) -> Option<&ComponentPatchEntry>

Gets the patch entry for a key.

pub fn is_removed(&self, key: &Identifier) -> bool

Checks if a component is marked as removed.

pub fn count_set(&self) -> usize

Counts set entries.

pub fn count_removed(&self) -> usize

Counts removed entries.

pub fn iter(&self) -> impl Iterator<Item = (&Identifier, &ComponentPatchEntry)>

Iterates over all entries.

pub fn iter_removed(&self) -> impl Iterator<Item = &Identifier>

Iterates over removed component keys.

pub fn to_nbt_tag_ref(&self) -> OwnedNbtTag

Converts this component patch to NBT without consuming it.

impl DataComponentPatch

pub fn read_delimited(data: &mut Cursor<&[u8]>) -> Result<Self>

Reads a patch where each component value is prefixed with a VarInt byte length.

Vanilla uses this for untrusted client packets (e.g., creative mode slot) via DataComponentPatch.DELIMITED_STREAM_CODEC.

Trait Implementations

impl Clone for DataComponentPatch

fn clone(&self) -> DataComponentPatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataComponentPatch

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

Formats the value using the given formatter.

impl Default for DataComponentPatch

fn default() -> DataComponentPatch

Returns the “default value” for a type.

impl FromNbtTag for DataComponentPatch

fn from_nbt_tag(tag: BorrowedNbtTag<'_, '_>) -> Option<Self>

fn from_optional_nbt_tag( tag: Option<NbtTag<'_, '_>>, ) -> Result<Option<Self>, DeserializeError>

impl PartialEq for DataComponentPatch

fn eq(&self, other: &DataComponentPatch) -> 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 ReadFrom for DataComponentPatch

fn read(data: &mut Cursor<&[u8]>) -> Result<Self>

Reads data from a cursor.

impl StructuralPartialEq for DataComponentPatch

impl ToNbtTag for DataComponentPatch

fn to_nbt_tag(self) -> OwnedNbtTag

fn to_optional_nbt_tag(self) -> Option<NbtTag>

impl WriteTo for DataComponentPatch

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

Writes data to a writer.