Struct specs::storage::Entries

pub struct Entries<'a, 'b: 'a, T: 'a, D: 'a>(_);

Join-able structure that yields all indices, returning Entry for all elements

Trait Implementations

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

type Mask = BitSetAll

Type of joined bit mask.

type Type = StorageEntry<'a, 'b, T, D>

Type of joined components.

type Value = &'a mut Storage<'b, T, D>

Type of joined storages.

unsafe fn open(self) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get(value: &mut Self::Value, id: Index) -> Self::Type

Get a joined component value by a given index.

fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

Important traits for JoinIter<J>

impl<J: Join> Iterator for JoinIter<J> type Item = J::Type;

fn join(self) -> JoinIter<Self> where
    Self: Sized, 

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self> where
    Self: Sized, 

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.