Struct EntityDenseMap

pub struct EntityDenseMap { /* private fields */ }

A structure to store entities in a dense array.

Implementations

impl EntityDenseMap

pub fn with_capacity(capacity: usize) -> Self

Creates a new EntityDenseMap with the specified initial capacity, ensuring it is a power of two.

pub fn is_empty(&self) -> bool

Tells if there are no eentities stored.

pub fn len(&self) -> usize

Returns number of entities stored.

pub fn clear(&mut self)

Clears the map, removing all entities from it.

pub fn insert(&mut self, entity: Entity) -> Result<usize, usize>

Inserts a new entity into the map. Returns Err(index) if the entity already exists, otherwise Ok(index) with the insertion index.

pub fn remove(&mut self, entity: Entity) -> Option<usize>

Removes an entity from the map and returns its index if it was found.

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

Checks whether the specified entity is present in the map.

pub fn index_of(&self, entity: Entity) -> Option<usize>

Finds the index of the specified entity in the map.

pub fn get(&self, index: usize) -> Option<Entity>

Retrieves the entity at the given index if available.

pub fn iter(&self) -> impl Iterator<Item = Entity> + '_

Returns an iterator over the entities in the map.

pub fn entities(&self) -> &[Entity]

Returns slice to all entities.

Trait Implementations

impl Clone for EntityDenseMap

fn clone(&self) -> EntityDenseMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityDenseMap

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

Formats the value using the given formatter.

impl Default for EntityDenseMap

fn default() -> EntityDenseMap

Returns the “default value” for a type.

impl PartialEq for EntityDenseMap

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

impl StructuralPartialEq for EntityDenseMap