Struct amethyst::ecs::storage::OccupiedEntry

pub struct OccupiedEntry<'a, 'b, T, D> where
    'b: 'a,
    D: 'a,
    T: 'a,  { /* fields omitted */ }

An entry to a storage which has a component associated to the entity.

Methods

impl<'a, 'b, T, D> OccupiedEntry<'a, 'b, T, D> where     D: Deref<Target = MaskedStorage<T>>,     T: Component,

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn get(&self) -> &T

Get a reference to the component associated with the entity.

impl<'a, 'b, T, D> OccupiedEntry<'a, 'b, T, D> where     D: DerefMut<Target = MaskedStorage<T>>,     T: Component,

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the component associated with the entity.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn into_mut(self) -> &'a mut T

Converts the OccupiedEntry into a mutable reference bounded by the storage's lifetime.

pub fn insert(&mut self, component: T) -> T

Inserts a value into the storage and returns the old one.

pub fn remove(self) -> T

Removes the component from the storage and returns it.