Skip to main content

BlockEntityStorage

Struct BlockEntityStorage 

Source
pub(crate) struct BlockEntityStorage {
    entries: SyncRwLock<BlockEntityEntries>,
}
Expand description

Storage for block entities in a chunk.

Ticker iteration is world-owned. This storage only owns chunk-persistent entities and lazy-promotion markers.

Fields§

§entries: SyncRwLock<BlockEntityEntries>

Related entity and marker state shares one lock. This makes replacement, promotion, removal, and persistence snapshots linearizable.

Implementations§

Source§

impl BlockEntityStorage

Source

pub(crate) fn new() -> Self

Creates a new empty block entity storage.

Source

pub(crate) fn get(&self, pos: BlockPos) -> Option<SharedBlockEntity>

Gets a block entity at the given position.

Source

pub(crate) fn contains_same( &self, pos: BlockPos, expected: &SharedBlockEntity, ) -> bool

Returns whether expected is the exact current concrete owner.

Source

pub(crate) fn lookup(&self, pos: BlockPos) -> BlockEntityLookup

Classifies a position with one lock acquisition and one entity-map probe.

Source

pub(crate) fn get_all(&self) -> Vec<SharedBlockEntity>

Returns all block entities in this storage.

Source

pub(crate) fn get_all_without_lifecycle_filter(&self) -> Vec<SharedBlockEntity>

Returns every concrete entry without applying LevelChunk lifecycle filtering.

Source

pub(crate) fn save_snapshot(&self) -> (Vec<SharedBlockEntity>, Vec<BlockPos>)

Atomically snapshots concrete entities and packed markers for persistence.

Source

pub(crate) fn save_snapshot_without_lifecycle_filter( &self, ) -> (Vec<SharedBlockEntity>, Vec<BlockPos>)

Atomically snapshots Chunk entries without applying Full lifecycle filtering.

Vanilla ProtoChunk storage is a raw map: removed flags are neither changed nor consulted until transfer into a LevelChunk.

Source

pub(crate) fn pending_positions(&self) -> Vec<BlockPos>

Returns packed block-entity positions without changing them.

Source

pub(crate) fn remove_pending(&self, pos: BlockPos)

Removes one invalid packed marker without constructing an entity.

Source

pub(crate) fn set_pending(&self, pos: BlockPos) -> bool

Adds a packed marker only when no concrete entity owns the position.

Source

pub(crate) fn len(&self) -> usize

Returns the number of block entities in this storage.

Source

pub(crate) fn set_without_lifecycle( &self, block_entity: &SharedBlockEntity, ) -> bool

Sets a Chunk block entity without invoking LevelChunk lifecycle callbacks.

Vanilla ProtoChunk map replacement neither clears nor sets the removed flag.

Source

pub(crate) fn adopt_if_same_staged( &self, pos: BlockPos, expected: &SharedBlockEntity, block_state: BlockStateId, ) -> Option<SmallVec<[SharedBlockEntity; 2]>>

Adopts an existing pre-Full entity in place and stages its Full lifecycle updates.

Returns None if expected no longer owns the position.

Source

pub(crate) fn discard_if_same_without_lifecycle( &self, pos: BlockPos, expected: &SharedBlockEntity, ) -> bool

Discards an invalid pre-Full entity only while it still owns the position.

Promotion is an ownership transfer, not an unload, so this deliberately queues no removal lifecycle event.

Source

pub(crate) fn remove_staged( &self, pos: BlockPos, ) -> (bool, SmallVec<[SharedBlockEntity; 2]>)

Removes an entity or marker while staging lifecycle callbacks for an outer lock boundary.

Source

pub(crate) fn detach_and_queue_removal( &self, pos: BlockPos, ) -> DetachedBlockEntity

Detaches the old owner without invoking callbacks.

The removal flag/event is queued while storage still owns the entity. This lets a reentrant same-Arc insertion order its clear transition after removal even though the caller delays callback dispatch until pre-removal side effects have run.

Source

pub(crate) fn remove_without_lifecycle(&self, pos: BlockPos) -> bool

Removes Chunk entity data without invoking LevelChunk lifecycle callbacks.

Source

pub(crate) fn remove_if_same_and_removed( &self, pos: BlockPos, expected: &SharedBlockEntity, ) -> bool

Removes the entity only if expected still owns pos.

This prevents a stale reader from deleting a concurrent replacement.

Source

pub(crate) fn add_staged( &self, block_entity: &SharedBlockEntity, block_state: BlockStateId, ) -> (bool, SmallVec<[SharedBlockEntity; 2]>)

Adds an entity while staging callbacks for dispatch after outer chunk locks are dropped.

Source

fn set_inner( &self, block_entity: &SharedBlockEntity, block_state: BlockStateId, ) -> (bool, SmallVec<[SharedBlockEntity; 2]>)

Source

pub(crate) fn insert_if_absent_staged( &self, block_entity: &SharedBlockEntity, block_state: BlockStateId, ) -> BlockEntityInsert

Inserts without replacing a concurrent concrete owner.

Source

fn promote_entry( &self, expected_pos: BlockPos, block_entity: SharedBlockEntity, block_state: Option<BlockStateId>, update_lifecycle: bool, ) -> (Option<SharedBlockEntity>, SmallVec<[SharedBlockEntity; 2]>)

Source

pub(crate) fn promote_without_lifecycle( &self, expected_pos: BlockPos, block_entity: SharedBlockEntity, ) -> Option<SharedBlockEntity>

Atomically replaces a packed marker with a concrete proto entity without lifecycle work.

Source

pub(crate) fn promote_staged( &self, expected_pos: BlockPos, block_state: BlockStateId, block_entity: SharedBlockEntity, ) -> (Option<SharedBlockEntity>, SmallVec<[SharedBlockEntity; 2]>)

Promotes a marker while staging callbacks for dispatch after outer locks are dropped.

Source

pub(crate) fn update_if_same_staged( &self, pos: BlockPos, block_entity: &SharedBlockEntity, block_state: BlockStateId, ) -> (bool, SmallVec<[SharedBlockEntity; 2]>)

Updates cached state only while block_entity still owns pos.

Source

pub(crate) fn remove_if_same_staged( &self, pos: BlockPos, expected: &dyn BlockEntity, ) -> (bool, SmallVec<[SharedBlockEntity; 2]>)

Removes expected only while it still owns pos, staging its callback.

Source

pub(crate) fn clear_and_stage_lifecycle_callbacks(&self) -> ClearedBlockEntities

Clears storage and returns entities whose lifecycle callback dispatcher this call owns.

Callers that hold outer chunk-map or holder guards can drop them before dispatching.

Source

pub(crate) fn clear_without_lifecycle(&self)

Clears Chunk entity data without invoking LevelChunk lifecycle callbacks.

Trait Implementations§

Source§

impl Debug for BlockEntityStorage

Source§

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

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

impl Default for BlockEntityStorage

Source§

fn default() -> Self

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

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> 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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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