Struct oxygengine_core::ecs::pipeline::PreparedQuery
source · [−]pub struct PreparedQuery<Q>where
Q: Query,{ /* private fields */ }Expand description
A prepared query can be stored independently of the World to amortize query set-up costs.
Implementations
sourceimpl<Q> PreparedQuery<Q>where
Q: Query,
impl<Q> PreparedQuery<Q>where
Q: Query,
sourcepub fn new() -> PreparedQuery<Q>
pub fn new() -> PreparedQuery<Q>
Create a prepared query which is not yet attached to any world
sourcepub fn query(&'q mut self, world: &'q World) -> PreparedQueryBorrow<'q, Q>
pub fn query(&'q mut self, world: &'q World) -> PreparedQueryBorrow<'q, Q>
Query world, using dynamic borrow checking
This will panic if it would violate an existing unique reference or construct an invalid unique reference.
sourcepub fn query_mut(&'q mut self, world: &'q mut World) -> PreparedQueryIter<'q, Q>ⓘNotable traits for PreparedQueryIter<'q, Q>impl<'q, Q> Iterator for PreparedQueryIter<'q, Q>where
Q: Query, type Item = (Entity, <<Q as Query>::Fetch as Fetch<'q>>::Item);
pub fn query_mut(&'q mut self, world: &'q mut World) -> PreparedQueryIter<'q, Q>ⓘNotable traits for PreparedQueryIter<'q, Q>impl<'q, Q> Iterator for PreparedQueryIter<'q, Q>where
Q: Query, type Item = (Entity, <<Q as Query>::Fetch as Fetch<'q>>::Item);
Q: Query, type Item = (Entity, <<Q as Query>::Fetch as Fetch<'q>>::Item);
Query a uniquely borrowed world
Avoids the cost of the dynamic borrow checking performed by query.
sourcepub fn view_mut(&'q mut self, world: &'q mut World) -> PreparedView<'q, Q>
pub fn view_mut(&'q mut self, world: &'q mut World) -> PreparedView<'q, Q>
Provide random access to query results for a uniquely borrow world
Trait Implementations
sourceimpl<Q> Default for PreparedQuery<Q>where
Q: Query,
impl<Q> Default for PreparedQuery<Q>where
Q: Query,
sourcefn default() -> PreparedQuery<Q>
fn default() -> PreparedQuery<Q>
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl<Q> RefUnwindSafe for PreparedQuery<Q>where
<Q as Query>::Fetch: RefUnwindSafe,
<<Q as Query>::Fetch as Fetch<'static>>::State: RefUnwindSafe,
impl<Q> Send for PreparedQuery<Q>where
<Q as Query>::Fetch: Send,
<<Q as Query>::Fetch as Fetch<'static>>::State: Send,
impl<Q> Sync for PreparedQuery<Q>where
<Q as Query>::Fetch: Sync,
<<Q as Query>::Fetch as Fetch<'static>>::State: Sync,
impl<Q> Unpin for PreparedQuery<Q>
impl<Q> UnwindSafe for PreparedQuery<Q>where
<Q as Query>::Fetch: UnwindSafe,
<<Q as Query>::Fetch as Fetch<'static>>::State: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more