Struct bones_framework::lib::ecs::prelude::OptionalQueryItem

pub struct OptionalQueryItem<'a, T, S>(pub &'a S, pub PhantomData<&'a T>)
where
    T: HasSchema;

Wrapper for the Comp SystemParam used as QueryItem to iterate over entities optionally retrieving components from ComponentStore. Entities iterated over will not be filtered by OptionalQueryItem.

See Optional helper func for constructing OptionalQueryItem and usage.

Tuple Fields

0: &'a S

1: PhantomData<&'a T>

Trait Implementations

impl<'a, T, S, C> QueryItem for &'a OptionalQueryItem<'a, T, S>

where T: HasSchema, C: ComponentIterBitset<'a, T> + 'a, S: Deref<Target = C> + 'a,

Immutably iterate over optional component with syntax: &Optional(&Comp<T>) / &Optional(&CompMut<T>). (For mutable optional iteration we require &mut OptionalMut(&mut CompMut<T>))

type Iter = Map<UntypedComponentOptionalBitsetIterator<'a>, for<'b> fn(_: Option<SchemaRef<'b>>) -> Option<&'b T>>

The type of iterator this query item creates

fn apply_bitset(&self, _bitset: &mut BitSetVec)

Modify the iteration bitset

fn get_single_with_bitset( self, bitset: Rc<BitSetVec>, ) -> Result<<<&'a OptionalQueryItem<'a, T, S> as QueryItem>::Iter as Iterator>::Item, QuerySingleError>

Return the item that matches the query within the given bitset if there is exactly one entity that matches this query item.

fn iter_with_bitset( self, bitset: Rc<BitSetVec>, ) -> <&'a OptionalQueryItem<'a, T, S> as QueryItem>::Iter

Return an iterator over the provided bitset.