Struct Collection

pub struct Collection<T: HasId> { /* private fields */ }

A collection of identifiable entities

This behaves kind of like a HashSet, but only entities’ ids are used Another difference is that it allows for getting mutable references

Implementations

impl<T: HasId> Collection<T>

pub fn new() -> Self

Construct an empty collection

pub fn insert(&mut self, entity: T)

Insert a new entity into the collection

pub fn get(&self, id: &T::Id) -> Option<&T>

Get an entity by its id

pub fn get_mut(&mut self, id: &T::Id) -> Option<&mut T>

Get a mutable ref to an entity by its id

pub fn remove(&mut self, id: &T::Id) -> Option<T>

Remove an entity by its id

pub fn retain<F: FnMut(&T) -> bool>(&mut self, f: F)

Retain only entities specified by the predicate

pub fn iter(&self) -> impl Iterator<Item = &T>

Gets an iterator over the entities

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Gets an iterator over mutable refs of the entities

pub fn ids(&self) -> impl Iterator<Item = &T::Id> + '_

Gets an iterator of entities’ ids

pub fn len(&self) -> usize

Get number of entities in the collection

pub fn is_empty(&self) -> bool

Check if collection is empty

pub fn clear(&mut self)

Remove all entities from the collection

Trait Implementations

impl<T: Clone + HasId> Clone for Collection<T>

where T::Id: Clone,

fn clone(&self) -> Collection<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + HasId> Debug for Collection<T>

where T::Id: Debug,

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

Formats the value using the given formatter.

impl<T: HasId> Default for Collection<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Collection<T>

where T: Deserialize<'de> + HasId,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: HasId + Clone + Diff> Diff for Collection<T>

type Delta = Option<CollectionDelta<T>>

Object representing the difference between two states of Self

fn diff(&self, to: &Self) -> Self::Delta

Calculate the difference between two states

fn update(&mut self, delta: &Self::Delta)

Update the state using the delta

impl<T: HasId> Extend<T> for Collection<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, entities: I)

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.

impl<T: HasId> FromIterator<T> for Collection<T>

fn from_iter<I: IntoIterator<Item = T>>(entities: I) -> Self

Creates a value from an iterator.

impl<'a, T: HasId> IntoIterator for &'a Collection<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a T> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: HasId> IntoIterator for &'a mut Collection<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a mut T> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: HasId + 'static> IntoIterator for Collection<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq + HasId> PartialEq for Collection<T>

where T::Id: PartialEq,

fn eq(&self, other: &Collection<T>) -> 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> Serialize for Collection<T>

where T: Serialize + HasId,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq + HasId> Eq for Collection<T>

where T::Id: Eq,

impl<T: HasId> StructuralPartialEq for Collection<T>