Struct FilteredAccessSet

pub struct FilteredAccessSet { /* 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 FilteredAccessSet

pub const fn new() -> Self

Creates an empty FilteredAccessSet.

pub fn combined_access(&self) -> &Access

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

pub fn is_compatible(&self, other: &FilteredAccessSet) -> 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) -> AccessConflicts

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

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

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

Adds the filtered access to the set.

pub fn add_unfiltered_resource_read(&mut self, index: ComponentId)

Adds a read access to a resource to the set.

pub fn add_unfiltered_resource_write(&mut self, index: ComponentId)

Adds a write access to a resource to the set.

pub fn add_unfiltered_read_all_resources(&mut self)

Adds read access to all resources to the set.

pub fn add_unfiltered_write_all_resources(&mut self)

Adds write access to all resources to the set.

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

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 Clone for FilteredAccessSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilteredAccessSet

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

Formats the value using the given formatter.

impl Default for FilteredAccessSet

fn default() -> FilteredAccessSet

Returns the “default value” for a type.

impl From<FilteredAccess> for FilteredAccessSet

fn from(filtered_access: FilteredAccess) -> Self

Converts to this type from the input type.

impl PartialEq for FilteredAccessSet

fn eq(&self, other: &FilteredAccessSet) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FilteredAccessSet

impl StructuralPartialEq for FilteredAccessSet