Expose SystemMeta field accessors (#5497) #7119
Conversation
alice-i-cecile
added
the
C-Usability
| self.last_change_tick | ||
| } | ||
|
|
||
| /// Set this system's last change tick. |
There was a problem hiding this comment.
Needs links and warnings.
| @@ -56,6 +86,18 @@ impl SystemMeta { | |||
| pub fn set_non_send(&mut self) { | |||
| self.is_send = false; | |||
| } | |||
|
|
|||
| /// Returns this system's last change tick. | |||
| @@ -43,6 +43,36 @@ impl SystemMeta { | |||
| &self.name | |||
| } | |||
|
|
|||
| /// Returns the system's component access set. | |||
| #[inline] | |||
| pub fn component_access_set(&self) -> &FilteredAccessSet<ComponentId> { | |||
There was a problem hiding this comment.
These should all be const, along with the other methods on this type.
alice-i-cecile
added
the
D-Complex
| @@ -43,6 +43,36 @@ impl SystemMeta { | |||
| &self.name | |||
| } | |||
|
|
|||
| /// Returns the system's component access set. | |||
There was a problem hiding this comment.
| /// Returns the system's component access set. | |
| /// Fetches the system's component access set. |
| &self.component_access_set | ||
| } | ||
|
|
||
| /// Returns a mutable reference to the system's component access set. |
There was a problem hiding this comment.
| /// Returns a mutable reference to the system's component access set. | |
| /// Fetches a mutable reference to the system's component access set. |
| /// Returns a mutable reference to the system's component access set. | ||
| /// | ||
| /// # Safety | ||
| /// This allows unsafe modifications to the component access set that can violate Bevy's scheduling soundness. |
There was a problem hiding this comment.
This isn't documenting the actual safety invariant. Editing the component access set needs to accurately reflect the actual mutable and immutable accesses the system (or parameter) fetches from the World.
| /// Returns a mutable reference to this system's archetype component access set. | ||
| /// | ||
| /// # Safety | ||
| /// This allows unsafe modifications to the archetype component access set that can violate Bevy's scheduling soundness. |
There was a problem hiding this comment.
This also must exactly reflect the safety invariants of using this.
| /// # Safety | ||
| /// This allows unsafe modifications to the component access set that can violate Bevy's scheduling soundness. | ||
| #[inline] | ||
| pub unsafe fn component_access_set_mut(&mut self) -> &mut FilteredAccessSet<ComponentId> { |
There was a problem hiding this comment.
The pub(crate) on the fields should be removed and the bevy_ecs uses of the access sets should use these accessors. Won't block on this, can be done in a followup PR.
| @@ -15,13 +15,13 @@ use super::{In, IntoSystem, ReadOnlySystem}; | |||
| /// The metadata of a [`System`]. | |||
| #[derive(Clone)] | |||
| pub struct SystemMeta { | |||
There was a problem hiding this comment.
When this gets rebased, please also make the spans public too.
Adds user-facing immutable and unsafe mutable accessors to
SystemMeta(see #5497).