Skip to main content

Query

Struct Query 

Source
pub struct Query<'a, Q: Query> { /* private fields */ }
Expand description

Fetches components matching Q from every entity that has them. Include Entity in Q to get entity IDs back out of iteration.

Implementations§

Source§

impl<'a, Q: Query> Query<'a, Q>

Source

pub fn iter(&mut self) -> impl Iterator<Item = Q::Item<'_>>

Iterates every matching entity’s components.

Source

pub fn get(&mut self, entity: Entity) -> Option<Q::Item<'_>>

Fetches one known entity directly, without scanning the rest of the query. None if it doesn’t exist or doesn’t match Q.

Source

pub fn with<R: Query>(self) -> Query<'a, With<Q, R>>

Narrows to entities that also have component(s) R, without R joining the yielded items. Chainable with .without::<S>().

Source

pub fn without<R: Query>(self) -> Query<'a, Without<Q, R>>

Narrows to entities that don’t have component(s) R.

Source

pub fn single(&mut self) -> Q::Item<'_>

Expects exactly one matching entity (the player, the active camera). Panics otherwise — use get_single if that’s not guaranteed.

Source

pub fn get_single(&mut self) -> Option<Q::Item<'_>>

Same as single, but None instead of panicking when there isn’t exactly one match.

Trait Implementations§

Source§

impl<'a, Q: Query> IntoIterator for &'a mut Query<'a, Q>

Source§

type Item = <Q as Query>::Item<'a>

The type of the elements being iterated over.
Source§

type IntoIter = QueryIter<'a, Q>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<Q> SystemParam for Query<'static, Q>
where Q: Query + 'static,

Source§

type Item<'a> = Query<'a, Q>

The value actually handed to the system function.
Source§

type State = ()

Per-system persistent state (e.g. Local’s stored value) — () for anything stateless.
Source§

fn fetch<'a>( world: &'a World, _resources: &'a Resources, _state: &'a mut Self::State, ) -> Self::Item<'a>

Auto Trait Implementations§

§

impl<'a, Q> Freeze for Query<'a, Q>

§

impl<'a, Q> RefUnwindSafe for Query<'a, Q>
where Q: RefUnwindSafe, <<Q as Query>::Fetch as Fetch>::State: RefUnwindSafe,

§

impl<'a, Q> Send for Query<'a, Q>
where <Q as Query>::Item<'a>: for<'a> Send,

§

impl<'a, Q> Sync for Query<'a, Q>
where <Q as Query>::Item<'a>: for<'a> Send,

§

impl<'a, Q> Unpin for Query<'a, Q>
where Q: Unpin,

§

impl<'a, Q> UnsafeUnpin for Query<'a, Q>

§

impl<'a, Q> UnwindSafe for Query<'a, Q>
where Q: UnwindSafe, <<Q as Query>::Fetch as Fetch>::State: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more