Skip to content

[Merged by Bors] - Revise docs for system set marker traits #7882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

[Merged by Bors] - Revise docs for system set marker traits #7882

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
818fa87
revise docs for system set marker traits
joseph-gio Mar 3, 2023
802c632
marker traits are automatically implemented
joseph-gio Mar 3, 2023
bd27e2f
sentences
joseph-gio Mar 3, 2023
e20950d
use more specific language
joseph-gio Mar 3, 2023
a33ffef
Fix typos
joseph-gio Mar 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions crates/bevy_ecs/src/schedule/set.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,18 @@ pub trait SystemSet: DynHash + Debug + Send + Sync + 'static {
fn dyn_clone(&self) -> Box<dyn SystemSet>;
}

/// A system set that is never contained in another set.
/// Systems and other system sets may only belong to one base set.
/// A marker trait for `SystemSet` types where [`is_base`] returns `true`.
/// This should only be implemented for types that satisfy this requirement.
/// It is automatically implemented for base set types by `#[derive(SystemSet)]`.
///
/// This should only be implemented for types that return `true` from [`SystemSet::is_base`].
/// [`is_base`]: SystemSet::is_base
pub trait BaseSystemSet: SystemSet {}

/// System sets that are *not* base sets. This should not be implemented for
/// any types that implement [`BaseSystemSet`].
/// A marker trait for `SystemSet` types where [`is_base`] returns `false`.
/// This should only be implemented for types that satisfy this requirement.
/// It is automatically implemented for non-base set types by `#[derive(SystemSet)]`.
///
/// [`is_base`]: SystemSet::is_base
pub trait FreeSystemSet: SystemSet {}

impl PartialEq for dyn SystemSet {
Expand Down