Struct oxygengine_core::ecs::storage::Entries

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

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

Trait Implementations

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

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

Type of joined components.

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

Type of joined storages.

type Mask = BitSetAll

Type of joined bit mask.

unsafe fn open(
    self
) -> (<Entries<'a, 'b, T, D> as Join>::Mask, <Entries<'a, 'b, T, D> as Join>::Value)

Open this join by returning the mask and the storages.

unsafe fn get(
    value: &mut <Entries<'a, 'b, T, D> as Join>::Value,
    id: u32
) -> <Entries<'a, 'b, T, D> as Join>::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> Iterator for JoinIter<J> where
    J: Join,  type Item = <J as Join>::Type;

fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

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