Module query
Expand description
Contains APIs for retrieving component data from the world.
Structs§
- Access
- Tracks read and write access to specific elements in a collection.
- Added
- A filter on a component that only retains results the first time after they have been added.
- AnyOf
- The
AnyOfquery parameter fetches entities with any of the component types included in T. - Changed
- A filter on a component that only retains results the first time after they have been added or mutably dereferenced.
- Filtered
Access - An
Accessthat has been filtered to include and exclude certain combinations of elements. - Filtered
Access Set - A collection of
FilteredAccessinstances. - Has
- Returns a bool that describes if an entity has the component
T. - Or
- A filter that tests if any of the given filters apply.
- Query
Builder - Builder struct to create
QueryStateinstances at runtime. - Query
Combination Iter - An iterator over
K-sized combinations of query items without repetition. - Query
Iter - An
Iteratorover query results of aQuery. - Query
Many Iter - An
Iteratorover the query items generated from an iterator ofEntitys. - Query
ParIter - A parallel iterator over query results of a
Query. - Query
Sorted Iter - An
Iteratorover sorted query results of aQuery. - Query
State - Provides scoped access to a
Worldstate according to a givenQueryDataandQueryFilter. - With
- Filter that selects entities with a component
T. - Without
- Filter that selects entities without a component
T.
Enums§
- Query
Entity Error - An error that occurs when retrieving a specific
Entity’s query result fromQueryorQueryState. - Query
Single Error - An error that occurs when evaluating a
QueryorQueryStateas a single expected result viaget_singleorget_single_mut.
Traits§
- Archetype
Filter - A marker trait to indicate that the filter works at an archetype level.
- Query
Data - Types that can be fetched from a
Worldusing aQuery. - Query
Filter - Types that filter the results of a
Query. - Read
Only Query Data - A
QueryDatathat is read only. - World
Query - Types that can be used as parameters in a
Query. Types that implement this should also implement eitherQueryDataorQueryFilter
Type Aliases§
- Query
Item - The item type returned when a
WorldQueryis iterated over - ROQuery
Item - The read-only variant of the item type returned when a
QueryDatais iterated over immutably
Derive Macros§
- Query
Data - Implement
QueryDatato use a struct as a data parameter in a query - Query
Filter - Implement
QueryFilterto use a struct as a filter parameter in a query