Struct Access 

pub struct Access { /* private fields */ }

Describes the component access pattern for a query.

Used by the scheduler to determine which systems can run in parallel.

Implementations

impl Access

pub fn new() -> Self

Creates a new empty access descriptor.

pub fn add_read(&mut self, id: ComponentId)

Adds a read access for the given component.

pub fn add_write(&mut self, id: ComponentId)

Adds a write access for the given component.

Write access implies read access.

pub fn reads(&self) -> impl Iterator<Item = &ComponentId>

Returns all components that are read (including those also written).

pub fn writes(&self) -> &BTreeSet<ComponentId>

Returns all components that are written.

pub fn reads_only(&self) -> impl Iterator<Item = &ComponentId>

Returns the set of read-only components (read but not written).

pub fn conflicts_with(&self, other: &Access) -> bool

Checks if this access conflicts with another.

Two accesses conflict if:

• One writes to a component that the other reads or writes
• One writes to a resource that the other reads or writes

pub fn is_read_only(&self) -> bool

Returns true if this access pattern is read-only.

This checks component, resource, and non-send resource access.

pub fn extend(&mut self, other: &Access)

Merges another access into this one.

pub fn add_resource_read(&mut self, id: ResourceId)

Adds a read access for the given resource.

pub fn add_resource_write(&mut self, id: ResourceId)

Adds a write access for the given resource.

Write access implies read access.

pub fn resource_reads(&self) -> impl Iterator<Item = &ResourceId>

Returns all resources that are read (including those also written).

pub fn resource_writes(&self) -> &BTreeSet<ResourceId>

Returns all resources that are written.

pub fn resource_reads_only(&self) -> impl Iterator<Item = &ResourceId>

Returns the set of read-only resources (read but not written).

pub fn resource_conflicts_with(&self, other: &Access) -> bool

Checks if resource access conflicts with another.

Two accesses conflict if one writes to a resource that the other reads or writes.

pub fn has_resource_access(&self) -> bool

Checks if this access has any resource access.

pub fn has_component_access(&self) -> bool

Checks if this access has any component access.

pub fn add_non_send_read(&mut self, id: NonSendResourceId)

Adds a read access for the given non-send resource.

pub fn add_non_send_write(&mut self, id: NonSendResourceId)

Adds a write access for the given non-send resource.

Write access implies read access.

pub fn non_send_reads(&self) -> impl Iterator<Item = &NonSendResourceId>

Returns all non-send resources that are read (including those also written).

pub fn non_send_writes(&self) -> &BTreeSet<NonSendResourceId>

Returns all non-send resources that are written.

pub fn non_send_reads_only(&self) -> impl Iterator<Item = &NonSendResourceId>

Returns the set of read-only non-send resources (read but not written).

pub fn non_send_conflicts_with(&self, other: &Access) -> bool

Checks if non-send resource access conflicts with another.

Two accesses conflict if one writes to a non-send resource that the other reads or writes.

pub fn has_non_send_access(&self) -> bool

Checks if this access has any non-send resource access.

pub fn requires_main_thread(&self) -> bool

Returns true if this access requires execution on the main thread.

This returns true if there is any non-send resource access.

pub fn get_conflicts(&self, other: &Access) -> Option<AccessConflict>

Returns detailed information about conflicts between this access and another.

If there are no conflicts, returns None. Otherwise, returns an AccessConflict describing all the conflicting components and resources.

Example

use goud_engine::ecs::query::Access;
use goud_engine::ecs::component::ComponentId;
use goud_engine::ecs::Component;

#[derive(Clone, Copy)]
struct Position { x: f32, y: f32 }
impl Component for Position {}

let mut access1 = Access::new();
access1.add_write(ComponentId::of::<Position>());

let mut access2 = Access::new();
access2.add_read(ComponentId::of::<Position>());

let conflict = access1.get_conflicts(&access2);
assert!(conflict.is_some());
let conflict = conflict.unwrap();
assert_eq!(conflict.component_conflicts().len(), 1);

pub fn is_empty(&self) -> bool

Returns true if this access is empty (no reads or writes).

pub fn clear(&mut self)

Clears all access information.

Trait Implementations

impl Clone for Access

fn clone(&self) -> Access

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Access

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

Formats the value using the given formatter.

impl Default for Access

fn default() -> Access

Returns the “default value” for a type.