pub struct QueryBuilder<'w, D = (), F = ()>
where D: QueryData, F: QueryFilter,
{ /* private fields */ }
Expand description

Builder struct to create QueryState instances at runtime.

let mut world = World::new();
let entity_a = world.spawn((A, B)).id();
let entity_b = world.spawn((A, C)).id();

// Instantiate the builder using the type signature of the iterator you will consume
let mut query = QueryBuilder::<(Entity, &B)>::new(&mut world)
// Add additional terms through builder methods
    .with::<A>()
    .without::<C>()
    .build();

// Consume the QueryState
let (entity, b) = query.single(&world);

Implementations§

source§

impl<'w, D, F> QueryBuilder<'w, D, F>
where D: QueryData, F: QueryFilter,

source

pub fn new(world: &'w mut World) -> QueryBuilder<'w, D, F>

Creates a new builder with the accesses required for Q and F

source

pub fn world(&self) -> &World

Returns a reference to the world passed to Self::new.

source

pub fn world_mut(&mut self) -> &mut World

Returns a mutable reference to the world passed to Self::new.

source

pub fn extend_access(&mut self, access: FilteredAccess<ComponentId>)

Adds access to self’s underlying FilteredAccess respecting Self::or and Self::and

source

pub fn data<T>(&mut self) -> &mut QueryBuilder<'w, D, F>
where T: QueryData,

Adds accesses required for T to self.

source

pub fn filter<T>(&mut self) -> &mut QueryBuilder<'w, D, F>
where T: QueryFilter,

Adds filter from T to self.

source

pub fn with<T>(&mut self) -> &mut QueryBuilder<'w, D, F>
where T: Component,

Adds With<T> to the FilteredAccess of self.

source

pub fn with_id(&mut self, id: ComponentId) -> &mut QueryBuilder<'w, D, F>

Adds With<T> to the FilteredAccess of self from a runtime ComponentId.

source

pub fn without<T>(&mut self) -> &mut QueryBuilder<'w, D, F>
where T: Component,

Adds Without<T> to the FilteredAccess of self.

source

pub fn without_id(&mut self, id: ComponentId) -> &mut QueryBuilder<'w, D, F>

Adds Without<T> to the FilteredAccess of self from a runtime ComponentId.

source

pub fn ref_id(&mut self, id: ComponentId) -> &mut QueryBuilder<'w, D, F>

Adds &T to the FilteredAccess of self.

source

pub fn mut_id(&mut self, id: ComponentId) -> &mut QueryBuilder<'w, D, F>

Adds &mut T to the FilteredAccess of self.

source

pub fn optional( &mut self, f: impl Fn(&mut QueryBuilder<'_>) ) -> &mut QueryBuilder<'w, D, F>

Takes a function over mutable access to a QueryBuilder, calls that function on an empty builder and then adds all accesses from that builder to self as optional.

source

pub fn and( &mut self, f: impl Fn(&mut QueryBuilder<'_>) ) -> &mut QueryBuilder<'w, D, F>

Takes a function over mutable access to a QueryBuilder, calls that function on an empty builder and then adds all accesses from that builder to self.

Primarily used when inside a Self::or closure to group several terms.

source

pub fn or( &mut self, f: impl Fn(&mut QueryBuilder<'_>) ) -> &mut QueryBuilder<'w, D, F>

Takes a function over mutable access to a QueryBuilder, calls that function on an empty builder, all accesses added to that builder will become terms in an or expression.

QueryBuilder::<Entity>::new(&mut world).or(|builder| {
    builder.with::<A>();
    builder.with::<B>();
});
// is equivalent to
QueryBuilder::<Entity>::new(&mut world).filter::<Or<(With<A>, With<B>)>>();
source

pub fn access(&self) -> &FilteredAccess<ComponentId>

Returns a reference to the the FilteredAccess that will be provided to the built Query.

source

pub fn transmute<NewD>(&mut self) -> &mut QueryBuilder<'w, NewD>
where NewD: QueryData,

Transmute the existing builder adding required accesses. This will maintain all exisiting accesses.

If including a filter type see Self::transmute_filtered

source

pub fn transmute_filtered<NewD, NewF>( &mut self ) -> &mut QueryBuilder<'w, NewD, NewF>
where NewD: QueryData, NewF: QueryFilter,

Transmute the existing builder adding required accesses. This will maintain all existing accesses.

source

pub fn build(&mut self) -> QueryState<D, F>

Create a QueryState with the accesses of the builder.

Takes &mut self to access the innner world reference while initializing state for the new QueryState

Trait Implementations§

source§

impl<D, F> From<QueryBuilder<'_, D, F>> for QueryState<D, F>
where D: QueryData, F: QueryFilter,

source§

fn from(value: QueryBuilder<'_, D, F>) -> QueryState<D, F>

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'w, D, F> Freeze for QueryBuilder<'w, D, F>

§

impl<'w, D = (), F = ()> !RefUnwindSafe for QueryBuilder<'w, D, F>

§

impl<'w, D, F> Send for QueryBuilder<'w, D, F>
where D: Send, F: Send,

§

impl<'w, D, F> Sync for QueryBuilder<'w, D, F>
where D: Sync, F: Sync,

§

impl<'w, D, F> Unpin for QueryBuilder<'w, D, F>
where D: Unpin, F: Unpin,

§

impl<'w, D = (), F = ()> !UnwindSafe for QueryBuilder<'w, D, F>

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<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> DowncastSync for T
where T: Any + Send + Sync,

source§

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

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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> 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