Skip to main content

Access

Struct Access 

Source
pub struct Access { /* private fields */ }
Expand description

A system’s declared data access.

Implementations§

Source§

impl Access

Source

pub fn new() -> Access

An empty declaration: no components, no resources, not exclusive.

Source

pub fn reads_components(self, components: ComponentMask) -> Access

Declare the components step reads.

Source

pub fn writes_components(self, components: ComponentMask) -> Access

Declare the components step writes.

Source

pub fn reads_resources(self, resources: ComponentMask) -> Access

Declare the resources step reads.

Source

pub fn writes_resources(self, resources: ComponentMask) -> Access

Declare the resources step writes.

Source

pub fn exclusive(self) -> Access

Mark the system as exclusive: it conflicts with every other system and so never runs concurrently. Used for a system that touches non-shareable state the access masks do not model (e.g. a main-thread-only backend).

Source

pub fn is_exclusive(self) -> bool

Whether the system was marked exclusive.

Source

pub fn union(self, other: Access) -> Access

The combined access of two declarations: reads, writes, and exclusivity union. Used to fold a data-dependent system’s per-program accesses into its schedule-visible declaration.

Source

pub fn may_read_component(self, id: ComponentId) -> bool

Whether a read of this component id is within the declaration (a declared write implies read permission; exclusive allows everything).

Source

pub fn may_write_component(self, id: ComponentId) -> bool

Whether a write of this component id is within the declaration.

Source

pub fn may_read_resource(self, id: ComponentId) -> bool

Whether a read of this resource id is within the declaration (a declared write implies read permission).

Source

pub fn may_write_resource(self, id: ComponentId) -> bool

Whether a write of this resource id is within the declaration.

Source

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

Whether this system can run concurrently with other.

Trait Implementations§

Source§

impl Clone for Access

Source§

fn clone(&self) -> Access

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Access

Source§

impl Debug for Access

Source§

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

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

impl Default for Access

Source§

fn default() -> Access

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

impl Eq for Access

Source§

impl PartialEq for Access

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Access

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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, 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,

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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.