Struct valence::ecs::query::FilteredAccessSet

pub struct FilteredAccessSet<T>
where
    T: SparseSetIndex,
{ /* private fields */ }

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

impl<T> FilteredAccessSet<T>

where T: SparseSetIndex,

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

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

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.

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.

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.

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

Adds the filtered access to the set.

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

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

pub fn read_all(&mut self)

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

pub fn write_all(&mut self)

Marks the set as writing all T.

pub fn clear(&mut self)

Removes all accesses stored in this set.

Trait Implementations

impl<T> Clone for FilteredAccessSet<T>

where T: Clone + SparseSetIndex,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for FilteredAccessSet<T>

where T: Debug + SparseSetIndex,

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

Formats the value using the given formatter.

impl<T> Default for FilteredAccessSet<T>

where T: SparseSetIndex,

fn default() -> FilteredAccessSet<T>

Returns the “default value” for a type.

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

where T: SparseSetIndex,

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

Converts to this type from the input type.