Struct bevy_ecs::query::FilteredAccess

source ·
pub struct FilteredAccess<T: SparseSetIndex> { /* private fields */ }
Expand description

An Access that has been filtered to include and exclude certain combinations of elements.

Used internally to statically check if queries are disjoint.

Subtle: a read or write in access should not be considered to imply a with access.

For example consider Query<Option<&T>> this only has a read of T as doing otherwise would allow for queries to be considered disjoint when they shouldn’t:

  • Query<(&mut T, Option<&U>)> read/write T, read U, with U
  • Query<&mut T, Without<U>> read/write T, without U from this we could reasonably conclude that the queries are disjoint but they aren’t.

In order to solve this the actual access that Query<(&mut T, Option<&U>)> has is read/write T, read U. It must still have a read U access otherwise the following queries would be incorrectly considered disjoint:

  • Query<&mut T> read/write T
  • Query<Option<&T>> accesses nothing

See comments the WorldQuery impls of AnyOf/Option/Or for more information.

Implementations§

source§

impl<T: SparseSetIndex> FilteredAccess<T>

source

pub fn access(&self) -> &Access<T>

Returns a reference to the underlying unfiltered access.

source

pub fn access_mut(&mut self) -> &mut Access<T>

Returns a mutable reference to the underlying unfiltered access.

source

pub fn add_read(&mut self, index: T)

Adds access to the element given by index.

source

pub fn add_write(&mut self, index: T)

Adds exclusive access to the element given by index.

source

pub fn and_with(&mut self, index: T)

Adds a With filter: corresponds to a conjunction (AND) operation.

Suppose we begin with Or<(With<A>, With<B>)>, which is represented by an array of two AccessFilter instances. Adding AND With<C> via this method transforms it into the equivalent of Or<((With<A>, With<C>), (With<B>, With<C>))>.

source

pub fn and_without(&mut self, index: T)

Adds a Without filter: corresponds to a conjunction (AND) operation.

Suppose we begin with Or<(With<A>, With<B>)>, which is represented by an array of two AccessFilter instances. Adding AND Without<C> via this method transforms it into the equivalent of Or<((With<A>, Without<C>), (With<B>, Without<C>))>.

source

pub fn append_or(&mut self, other: &FilteredAccess<T>)

Appends an array of filters: corresponds to a disjunction (OR) operation.

As the underlying array of filters represents a disjunction, where each element (AccessFilters) represents a conjunction, we can simply append to the array.

source

pub fn extend_access(&mut self, other: &FilteredAccess<T>)

Adds all of the accesses from other to self.

source

pub fn is_compatible(&self, other: &FilteredAccess<T>) -> bool

Returns true if this and other can be active at the same time.

source

pub fn get_conflicts(&self, other: &FilteredAccess<T>) -> Vec<T>

Returns a vector of elements that this and other cannot access at the same time.

source

pub fn extend(&mut self, other: &FilteredAccess<T>)

Adds all access and filters from other.

Corresponds to a conjunction operation (AND) for filters.

Extending Or<(With<A>, Without<B>)> with Or<(With<C>, Without<D>)> will result in Or<((With<A>, With<C>), (With<A>, Without<D>), (Without<B>, With<C>), (Without<B>, Without<D>))>.

source

pub fn read_all(&mut self)

Sets the underlying unfiltered access as having access to all indexed elements.

source

pub fn write_all(&mut self)

Sets the underlying unfiltered access as having mutable access to all indexed elements.

source

pub fn is_subset(&self, other: &FilteredAccess<T>) -> bool

Returns true if the set is a subset of another, i.e. other contains at least all the values in self.

source

pub fn with_filters(&self) -> impl Iterator<Item = T> + '_

Returns the indices of the elements that this access filters for.

source

pub fn without_filters(&self) -> impl Iterator<Item = T> + '_

Returns the indices of the elements that this access filters out.

Trait Implementations§

source§

impl<T: Clone + SparseSetIndex> Clone for FilteredAccess<T>

source§

fn clone(&self) -> FilteredAccess<T>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T: Debug + SparseSetIndex> Debug for FilteredAccess<T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T: SparseSetIndex> Default for FilteredAccess<T>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<T: SparseSetIndex> From<FilteredAccess<T>> for FilteredAccessSet<T>

source§

fn from(filtered_access: FilteredAccess<T>) -> Self

Converts to this type from the input type.
source§

impl<T: PartialEq + SparseSetIndex> PartialEq for FilteredAccess<T>

source§

fn eq(&self, other: &FilteredAccess<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: Eq + SparseSetIndex> Eq for FilteredAccess<T>

source§

impl<T: SparseSetIndex> StructuralPartialEq for FilteredAccess<T>

Auto Trait Implementations§

§

impl<T> Freeze for FilteredAccess<T>

§

impl<T> RefUnwindSafe for FilteredAccess<T>
where T: RefUnwindSafe,

§

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

§

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

§

impl<T> Unpin for FilteredAccess<T>
where T: Unpin,

§

impl<T> UnwindSafe for FilteredAccess<T>
where T: 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 + 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> DynEq for T
where T: Any + Eq,

source§

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

Casts the type to dyn Any.
source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> TypeData for T
where T: 'static + Send + Sync + Clone,

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

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