Struct EntityList 

pub struct EntityList<T, Ref: EntityRef> { /* private fields */ }

A list of entities.

This implementation is essentially a glorified Vec<T>, which returns a Ref when pushed to. Of course, since it is indexed by EntityRefs, it can only index u32::MAX items. It can hold more items than this (if there is enough space in memory), but the items past the limit will be un-indexable by EntityRefs.

Implementations

impl<T, Ref: EntityRef> EntityList<T, Ref>

pub fn new() -> Self

Creates a new empty entity list.

pub fn push(&mut self, item: T) -> Ref

Pushes an item onto the end of the entity list, and returns a reference to it.

pub fn get(&self, item: Ref) -> &T

Returns the item associated with the given reference. Will panic if item is an invalid reference, or out of bounds.

pub fn get_mut(&mut self, item: Ref) -> &mut T

Returns a mutable reference to the provided item.

pub fn len(&self) -> usize

Returns the amount of items in the entity list.

pub fn entities(&self) -> &Vec<T>

Returns the entities which are currently stored in this entity list.

pub fn entities_mut(&mut self) -> &mut Vec<T>

Returns a mutable reference to the entities which are stored in this entity list.

Trait Implementations

impl<T: Clone, Ref: Clone + EntityRef> Clone for EntityList<T, Ref>

fn clone(&self) -> EntityList<T, Ref>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Ref: EntityRef> Debug for EntityList<T, Ref>

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

Formats the value using the given formatter.

impl<T: PartialEq, Ref: PartialEq + EntityRef> PartialEq for EntityList<T, Ref>

fn eq(&self, other: &EntityList<T, Ref>) -> 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<T, Ref: EntityRef> StructuralPartialEq for EntityList<T, Ref>