Struct Entities 

pub struct Entities { /* private fields */ }

The entity allocator: slot generations, the free list, and the reservation counter.

Implementations

impl Entities

pub fn new() -> Entities

An allocator with no slots.

pub fn alloc(&mut self) -> Entity

Allocate an entity, recycling a freed slot when one is available. The recycled slot keeps the generation it was bumped to at despawn, so old handles to it stay invalid.

pub fn reserve(&self) -> Entity

Reserve a fresh entity id without taking &mut self. Lock-free, so it is safe to call from worker threads while recording commands. Reserved ids are always fresh (never recycled) and carry the first generation; call flush under &mut self before looking them up.

pub fn flush(&mut self)

Materialize any reserved-but-unmaterialized ids into the metadata table, marking them alive. Idempotent.

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

Despawn an entity. Validates the generation, so a stale or already-dead handle is a no-op returning false. Bumps the slot’s generation and frees the index for reuse.

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

Whether the handle refers to a currently-live entity. Reflects only materialized state; reserved ids appear after flush.

Trait Implementations

impl Debug for Entities

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

Formats the value using the given formatter.

impl Default for Entities

fn default() -> Entities

Returns the “default value” for a type.