Struct bevy_ecs::query::FilteredAccessSet

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

A collection of FilteredAccess instances.

Used internally to statically check if systems have conflicting access.

It stores multiple sets of accesses.

  • A “combined” set, which is the access of all filters in this set combined.
  • The set of access of each individual filters in this set.

Implementations§

source§

impl<T: SparseSetIndex> FilteredAccessSet<T>

source

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

Returns a reference to the unfiltered access of the entire set.

source

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

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

Access conflict resolution happen in two steps:

  1. A “coarse” check, if there is no mutual unfiltered conflict between self and other, we already know that the two access sets are compatible.
  2. A “fine grained” check, it kicks in when the “coarse” check fails. the two access sets might still be compatible if some of the accesses are restricted with the With or Without filters so that access is mutually exclusive. The fine grained phase iterates over all filters in the self set and compares it to all the filters in the other set, making sure they are all mutually compatible.
source

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

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

source

pub fn get_conflicts_single( &self, filtered_access: &FilteredAccess<T> ) -> Vec<T>

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

source

pub fn add(&mut self, filtered_access: FilteredAccess<T>)

Adds the filtered access to the set.

source

pub fn extend(&mut self, filtered_access_set: FilteredAccessSet<T>)

Adds all of the accesses from the passed set to self.

source

pub fn read_all(&mut self)

Marks the set as reading all possible indices of type T.

source

pub fn write_all(&mut self)

Marks the set as writing all T.

source

pub fn clear(&mut self)

Removes all accesses stored in this set.

Trait Implementations§

source§

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

source§

fn clone(&self) -> FilteredAccessSet<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 FilteredAccessSet<T>

source§

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

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

impl<T: SparseSetIndex> Default for FilteredAccessSet<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.

Auto Trait Implementations§

§

impl<T> Freeze for FilteredAccessSet<T>

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for FilteredAccessSet<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> 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,