pub struct NopWorldQuery<D: QueryData>(/* private fields */);
Expand description

WorldQuery used to nullify queries by turning Query<D> into Query<NopWorldQuery<D>>

This will rarely be useful to consumers of bevy_ecs.

Trait Implementations§

source§

impl<D: QueryData> QueryData for NopWorldQuery<D>

SAFETY: Self::ReadOnly is Self

§

type ReadOnly = NopWorldQuery<D>

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.
source§

impl<D: QueryData> WorldQuery for NopWorldQuery<D>

SAFETY: update_component_access and update_archetype_component_access do nothing. This is sound because fetch does not access components.

§

type Item<'w> = ()

The item returned by this WorldQuery For QueryData this will be the item returned by the query. For QueryFilter this will be either (), or a bool indicating whether the entity should be included or a tuple of such things.
§

type Fetch<'w> = ()

Per archetype/table state used by this WorldQuery to fetch Self::Item
§

type State = <D as WorldQuery>::State

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.
source§

fn shrink<'wlong: 'wshort, 'wshort>(_: ())

This function manually implements subtyping for the query items.
source§

unsafe fn init_fetch( _world: UnsafeWorldCell<'_>, _state: &D::State, _last_run: Tick, _this_run: Tick )

Creates a new instance of this fetch. Read more
source§

const IS_DENSE: bool = D::IS_DENSE

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components. This is used to select a more efficient “table iterator” for “dense” queries. If this returns true, WorldQuery::set_table must be used before WorldQuery::fetch can be called for iterators. If this returns false, WorldQuery::set_archetype must be used before WorldQuery::fetch can be called for iterators.
source§

unsafe fn set_archetype( _fetch: &mut (), _state: &D::State, _archetype: &Archetype, _tables: &Table )

Adjusts internal state to account for the next Archetype. This will always be called on archetypes that match this WorldQuery. Read more
source§

unsafe fn set_table<'w>(_fetch: &mut (), _state: &D::State, _table: &Table)

Adjusts internal state to account for the next Table. This will always be called on tables that match this WorldQuery. Read more
source§

unsafe fn fetch<'w>( _fetch: &mut Self::Fetch<'w>, _entity: Entity, _table_row: TableRow ) -> Self::Item<'w>

Fetch Self::Item for either the given entity in the current Table, or for the given entity in the current Archetype. This must always be called after WorldQuery::set_table with a table_row in the range of the current Table or after WorldQuery::set_archetype with a entity in the current archetype. Read more
source§

fn update_component_access( _state: &D::State, _access: &mut FilteredAccess<ComponentId> )

Adds any component accesses used by this WorldQuery to access.
source§

fn init_state(world: &mut World) -> Self::State

Creates and initializes a State for this WorldQuery type.
source§

fn get_state(world: &World) -> Option<Self::State>

Attempts to initializes a State for this WorldQuery type.
source§

fn matches_component_set( state: &Self::State, set_contains_id: &impl Fn(ComponentId) -> bool ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.
source§

fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut. Read more
source§

impl<D: QueryData> ReadOnlyQueryData for NopWorldQuery<D>

SAFETY: NopFetch never accesses any data

Auto Trait Implementations§

§

impl<D> RefUnwindSafe for NopWorldQuery<D>
where D: RefUnwindSafe,

§

impl<D> Send for NopWorldQuery<D>
where D: Send,

§

impl<D> Sync for NopWorldQuery<D>
where D: Sync,

§

impl<D> Unpin for NopWorldQuery<D>
where D: Unpin,

§

impl<D> UnwindSafe for NopWorldQuery<D>
where D: UnwindSafe,

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