Struct mecs::entity::Entity

pub struct Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType,  { /* fields omitted */ }

An entity

Methods

impl<'a, S> Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType, 

#[must_use] pub fn new() -> Self

Creates an empty entity

#[must_use] pub fn from_components(components: Vec<S>) -> Self

Creates an entity from a list of components

pub fn add(&mut self, storage: S) -> Option<S>

Adds a new component to this entity

Return

If this entity already contains a component with the same id as the one in storage, it is returned.

pub fn remove<C: Component<'a, S>>(&mut self) -> Option<S>

Remove a component from this entity given it's type

pub fn remove_id(&mut self, id: &S::Id) -> Option<S>

Removes a component from this entity given it's id

#[must_use] pub fn get<C: Component<'a, S>>(&self) -> Option<&C>

Returns a reference to a component given it's type

Return

If either the component is not present in this entity or the component could not be build from the storage associated with it's id, this function will return None.

#[must_use] pub fn get_mut<C: Component<'a, S>>(&mut self) -> Option<&mut C>

Returns a mutable reference to a component given it's type

Return

If either the component is not present in this entity or the component could not be build from the storage associated with it's id, this function will return None.

#[must_use] pub fn get_id(&self, id: &S::Id) -> Option<&S>

Returns a reference to a component's storage given it's id

#[must_use] pub fn get_mut_id(&mut self, id: &S::Id) -> Option<&mut S>

Returns a mutable reference to a component's storage given it's id

pub fn ids(&self) -> impl Iterator<Item = &<S as Storage<'a>>::Id>

Returns an iterator over all component ids in this entity

#[must_use] pub fn components(&self) -> Values<S::Id, S>

Returns an iterator over all components in this entity

#[must_use] pub fn components_mut(&mut self) -> ValuesMut<S::Id, S>

Returns a mutable iterator over all components in this entity

#[must_use] pub fn has<C: Component<'a, S>>(&self) -> bool

Checks if this entity has a component given it's type

#[must_use] pub fn has_id(&self, id: &S::Id) -> bool

Checks if this entity has a component given it's id

Trait Implementations

impl<'a, S: Clone> Clone for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType,
    S::Id: Clone, 

fn clone(&self) -> Entity<'a, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug> Debug for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType,
    S::Id: Debug, 

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

Formats the value using the given formatter.

impl<'a, S> Default for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType, 

#[must_use] fn default() -> Self

Returns the "default value" for a type.

impl<'a, S: Eq> Eq for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType,
    S::Id: Eq, 

impl<'a, S: PartialEq> PartialEq<Entity<'a, S>> for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType,
    S::Id: PartialEq, 

fn eq(&self, other: &Entity<'a, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Entity<'a, S>) -> bool

This method tests for !=.

impl<'a, S> StructuralEq for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType, 

impl<'a, S> StructuralPartialEq for Entity<'a, S> where
    S: Storage<'a>,
    S::Id: KeyType,