Struct EntityAllocator

pub struct EntityAllocator { /* private fields */ }

Allocates and manages entity IDs and generations, allowing safe reuse of entity IDs.

Fields

• generations: Per-id generation counters used to validate entity liveness.
• free_ids: Pool of reusable entity IDs.

Safety

• Reuse safety is enforced by bumping the generation on destroy, invalidating stale Entity values that refer to the same id with an older generation.

Implementations

impl EntityAllocator

pub fn create(&mut self) -> Entity

Creates a new entity, reusing an ID if possible, otherwise assigning a new one.

Returns

• Entity: The newly allocated entity identifier (with current generation for its id).

pub fn destroy(&mut self, entity: Entity)

Destroys an entity, marking it as dead and adding its ID back to free pool.

Parameters

• entity: The entity to destroy. If already dead or invalid, this is a no-op.

pub fn is_alive(&self, entity: Entity) -> bool

Checks if an entity is alive by comparing its generation against stored generation.

Parameters

• entity: The entity identifier to check.

Returns

• bool: true if the entity is currently alive; false otherwise.

Trait Implementations

impl Default for EntityAllocator

fn default() -> EntityAllocator

Returns the “default value” for a type.