Struct apecs::Maybe

pub struct Maybe<T>(_);

Query type used to denote an optional column.

Use Maybe in queries to return bundles of components that may or may not contain a component of the wrapped type T.

Trait Implementations

impl<'s, T: Send + Sync + 'static> IsQuery for Maybe<&'s T>

type LockedColumns<'a> = Option<RwLockReadGuard<'a, RawRwLock, AnyVec<dyn Send + Sync + 'static, Heap>>>

Data that is read or write locked by performing this query.

type ExtensionColumns = ()

Data that can be used to append to columns. Typically vectors of component entries or bundles of vectors of component entries.

type QueryResult<'a> = Either<RepeatWith<fn() -> Option<&'a Entry<T>>>, Map<Iter<'a, Entry<T>>, fn(&'r Entry<T>) -> Option<&'r Entry<T>>>>

The iterator that is produced by performing a query on one archetype.

type ParQueryResult<'a> = Either<Map<RepeatN<()>, fn(()) -> Option<&'a Entry<T>>>, Map<Iter<'a, Entry<T>>, fn(&'r Entry<T>) -> Option<&'r Entry<T>>>>

The parallel iterator that is produced by performing a query on one archetype.

type QueryRow<'a> = Option<&'a Entry<T>>

The iterator item.

fn borrows() -> Vec<Borrow>

fn lock_columns<'a>(arch: &'a Archetype) -> Self::LockedColumns<'a>

Find and acquire a “lock” on the columns for reading or writing.

fn extend_locked_columns<'a, 'b>(
    _: &'b mut Self::LockedColumns<'a>,
    _: Self::ExtensionColumns,
    _: Option<(&mut Vec<usize>, &mut usize)>
)

Extend entries in the locked columns.

fn iter_mut<'a, 'b>(
    lock: &'b mut Self::LockedColumns<'a>
) -> Self::QueryResult<'b>

Create an iterator over the rows of the given columns.

fn iter_one<'a, 'b>(
    lock: &'b mut Self::LockedColumns<'a>,
    index: usize
) -> Self::QueryResult<'b>

Create an iterator over one row with the given index.

fn par_iter_mut<'a, 'b>(
    len: usize,
    lock: &'b mut Self::LockedColumns<'a>
) -> Self::ParQueryResult<'b>

Create an iterator over the rows of the given columns.

impl<'s, T: Send + Sync + 'static> IsQuery for Maybe<&'s mut T>

type LockedColumns<'a> = Option<RwLockWriteGuard<'a, RawRwLock, AnyVec<dyn Send + Sync + 'static, Heap>>>

Data that is read or write locked by performing this query.

type ExtensionColumns = ()

Data that can be used to append to columns. Typically vectors of component entries or bundles of vectors of component entries.

type QueryResult<'a> = Either<RepeatWith<fn() -> Option<&'a mut Entry<T>>>, Map<IterMut<'a, Entry<T>>, fn(&'r mut Entry<T>) -> Option<&'r mut Entry<T>>>>

The iterator that is produced by performing a query on one archetype.

type ParQueryResult<'a> = Either<Map<RepeatN<()>, fn(()) -> Option<&'a mut Entry<T>>>, Map<IterMut<'a, Entry<T>>, fn(&'r mut Entry<T>) -> Option<&'r mut Entry<T>>>>

The parallel iterator that is produced by performing a query on one archetype.

type QueryRow<'a> = Option<&'a mut Entry<T>>

The iterator item.

fn borrows() -> Vec<Borrow>

fn lock_columns<'a>(arch: &'a Archetype) -> Self::LockedColumns<'a>

Find and acquire a “lock” on the columns for reading or writing.

fn extend_locked_columns<'a, 'b>(
    _: &'b mut Self::LockedColumns<'a>,
    _: Self::ExtensionColumns,
    _: Option<(&mut Vec<usize>, &mut usize)>
)

Extend entries in the locked columns.

fn iter_mut<'a, 'b>(
    lock: &'b mut Self::LockedColumns<'a>
) -> Self::QueryResult<'b>

Create an iterator over the rows of the given columns.

fn iter_one<'a, 'b>(
    lock: &'b mut Self::LockedColumns<'a>,
    index: usize
) -> Self::QueryResult<'b>

Create an iterator over one row with the given index.

fn par_iter_mut<'a, 'b>(
    len: usize,
    lock: &'b mut Self::LockedColumns<'a>
) -> Self::ParQueryResult<'b>

Create an iterator over the rows of the given columns.