Skip to main content

DataComponentPatch

Struct DataComponentPatch 

Source
pub struct DataComponentPatch {
    pub(super) entries: FxHashMap<Identifier, ComponentPatchEntry>,
}
Expand description

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§

Source§

impl DataComponentPatch

Source

pub fn new() -> Self

Source

pub fn is_empty(&self) -> bool

Source

pub fn len(&self) -> usize

Source

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

Sets a component value in the patch.

Source

pub(crate) fn set_component_data( &mut self, key: Identifier, data: ComponentData, )

Source

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, or false if the key is unregistered or the data type does not match it.

This prevents plugins from setting invalid types on vanilla components.

Source

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

Marks a component as removed.

Source

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

Marks a dynamically resolved component as removed.

Source

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

Clears any patch entry for a component.

Source

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

Gets the patch entry for a key.

Source

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

Checks if a component is marked as removed.

Source

pub fn count_set(&self) -> usize

Counts set entries.

Source

pub fn count_removed(&self) -> usize

Counts removed entries.

Source

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

Iterates over all entries.

Source

pub fn apply(&mut self, added: &Self)

Applies another patch after this one, giving the added patch precedence.

Source

pub(crate) fn sanitize_against(&mut self, prototype: &DataComponentMap)

Source§

impl DataComponentPatch

Source

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.

Source§

impl DataComponentPatch

Source

pub(crate) fn compute_single_extracted_hash<T: HashComponent>( key: &Identifier, value: &T, ) -> i32

Computes the persistent map hash for one build-time validated component without consulting the not-yet-published global registry.

Source

pub fn compute_persistent_hash(&self) -> Result<i32>

Computes Vanilla’s HashOps value for the persistent patch codec.

Source

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

Iterates over removed component keys.

Source

fn encode_nbt(&self, validate: bool) -> (OwnedNbtTag, Vec<Error>)

Source

pub fn try_to_nbt_tag_ref(&self) -> Result<OwnedNbtTag>

Strictly encodes this component patch through its persistent codecs.

This is the equivalent of Vanilla encoding an untrusted stack through ItemStack.CODEC before accepting it into server state.

Source

pub fn to_nbt_tag_ref(&self) -> OwnedNbtTag

Converts this component patch to NBT without consuming it.

Save-time encoding mirrors Vanilla’s TagValueOutput: invalid fields are reported and omitted from the partial result rather than aborting the owner save.

Trait Implementations§

Source§

impl Clone for DataComponentPatch

Source§

fn clone(&self) -> DataComponentPatch

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DataComponentPatch

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DataComponentPatch

Source§

fn default() -> DataComponentPatch

Returns the “default value” for a type. Read more
Source§

impl EmbeddedNbtCodec for &DataComponentPatch

Source§

type Error = Error

Source§

fn encode_embedded_nbt(self) -> Result<OwnedNbtTag>

Source§

impl FromNbtTag for DataComponentPatch

Source§

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

§

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

Source§

impl PartialEq for DataComponentPatch

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl ReadFrom for DataComponentPatch

Source§

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

Reads data from a cursor.
Source§

impl StructuralPartialEq for DataComponentPatch

Source§

impl ToNbtTag for DataComponentPatch

Source§

fn to_nbt_tag(self) -> OwnedNbtTag

§

fn to_optional_nbt_tag(self) -> Option<NbtTag>

Source§

impl WriteTo for DataComponentPatch

Source§

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

Writes data to a writer.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more