Struct EntitySet

pub struct EntitySet<K>
where
    K: EntityRef,
{ /* private fields */ }

A set of K for densely indexed entity references.

The EntitySet data structure uses the dense index space to implement a set with a bitvector. Like SecondaryMap, an EntitySet is used to associate secondary information with entities.

Implementations

impl<K> EntitySet<K>

where K: EntityRef,

Shared EntitySet implementation for all value types.

pub fn new() -> Self

Create a new empty set.

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty set with the specified capacity.

pub fn ensure_capacity(&mut self, capacity: usize)

Ensure that the set has enough capacity to hold capacity total elements.

pub fn contains(&self, k: K) -> bool

Get the element at k if it exists.

pub fn is_empty(&self) -> bool

Is this set completely empty?

pub fn clear(&mut self)

Remove all entries from this set.

pub fn keys(&self) -> Keys<K>

Iterate over all the keys in this set.

pub fn insert(&mut self, k: K) -> bool

Insert the element at k.

pub fn pop(&mut self) -> Option<K>

Removes and returns the entity from the set if it exists.

Trait Implementations

impl<K> Clone for EntitySet<K>

where K: EntityRef + Clone,

fn clone(&self) -> EntitySet<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K> Debug for EntitySet<K>

where K: EntityRef + Debug,

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

Formats the value using the given formatter.

impl<K: EntityRef> Default for EntitySet<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K: EntityRef> Extend<K> for EntitySet<K>

fn extend<T: IntoIterator<Item = K>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.