Struct specs::storage::AntiStorage

pub struct AntiStorage<'a>(pub &'a BitSet);

An inverted storage type, only useful to iterate entities that do not have a particular component type.

Trait Implementations

impl<'a> ParJoin for AntiStorage<'a>

fn par_join(self) -> JoinParIter<Self> where
    Self: Sized, 

Create a joined parallel iterator over the contents.

impl<'a> Join for AntiStorage<'a>

type Mask = BitSetNot<&'a BitSet>

Type of joined bit mask.

type Type = ()

Type of joined components.

type Value = ()

Type of joined storages.

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

Open this join by returning the mask and the storages.

unsafe fn get(_: &mut (), _: Index)

Get a joined component value by a given index.

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.

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.

impl<'a> DistinctStorage for AntiStorage<'a>