pub struct Schedules {
pub ignored_scheduling_ambiguities: BTreeSet<ComponentId>,
/* private fields */
}
Expand description
Resource that stores Schedule
s mapped to ScheduleLabel
s excluding the current running Schedule
.
Fields§
§ignored_scheduling_ambiguities: BTreeSet<ComponentId>
List of ComponentId
s to ignore when reporting system order ambiguity conflicts
Implementations§
source§impl Schedules
impl Schedules
sourcepub fn insert(&mut self, schedule: Schedule) -> Option<Schedule>
pub fn insert(&mut self, schedule: Schedule) -> Option<Schedule>
Inserts a labeled schedule into the map.
If the map already had an entry for label
, schedule
is inserted,
and the old schedule is returned. Otherwise, None
is returned.
sourcepub fn remove(&mut self, label: impl ScheduleLabel) -> Option<Schedule>
pub fn remove(&mut self, label: impl ScheduleLabel) -> Option<Schedule>
Removes the schedule corresponding to the label
from the map, returning it if it existed.
sourcepub fn remove_entry(
&mut self,
label: impl ScheduleLabel
) -> Option<(InternedScheduleLabel, Schedule)>
pub fn remove_entry( &mut self, label: impl ScheduleLabel ) -> Option<(InternedScheduleLabel, Schedule)>
Removes the (schedule, label) pair corresponding to the label
from the map, returning it if it existed.
sourcepub fn contains(&self, label: impl ScheduleLabel) -> bool
pub fn contains(&self, label: impl ScheduleLabel) -> bool
Does a schedule with the provided label already exist?
sourcepub fn get(&self, label: impl ScheduleLabel) -> Option<&Schedule>
pub fn get(&self, label: impl ScheduleLabel) -> Option<&Schedule>
Returns a reference to the schedule associated with label
, if it exists.
sourcepub fn get_mut(&mut self, label: impl ScheduleLabel) -> Option<&mut Schedule>
pub fn get_mut(&mut self, label: impl ScheduleLabel) -> Option<&mut Schedule>
Returns a mutable reference to the schedule associated with label
, if it exists.
sourcepub fn entry(&mut self, label: impl ScheduleLabel) -> &mut Schedule
pub fn entry(&mut self, label: impl ScheduleLabel) -> &mut Schedule
Returns a mutable reference to the schedules associated with label
, creating one if it doesn’t already exist.
sourcepub fn iter(&self) -> impl Iterator<Item = (&dyn ScheduleLabel, &Schedule)>
pub fn iter(&self) -> impl Iterator<Item = (&dyn ScheduleLabel, &Schedule)>
Returns an iterator over all schedules. Iteration order is undefined.
sourcepub fn iter_mut(
&mut self
) -> impl Iterator<Item = (&dyn ScheduleLabel, &mut Schedule)>
pub fn iter_mut( &mut self ) -> impl Iterator<Item = (&dyn ScheduleLabel, &mut Schedule)>
Returns an iterator over mutable references to all schedules. Iteration order is undefined.
sourcepub fn configure_schedules(
&mut self,
schedule_build_settings: ScheduleBuildSettings
)
pub fn configure_schedules( &mut self, schedule_build_settings: ScheduleBuildSettings )
Applies the provided ScheduleBuildSettings
to all schedules.
sourcepub fn allow_ambiguous_component<T: Component>(&mut self, world: &mut World)
pub fn allow_ambiguous_component<T: Component>(&mut self, world: &mut World)
Ignore system order ambiguities caused by conflicts on Component
s of type T
.
sourcepub fn allow_ambiguous_resource<T: Resource>(&mut self, world: &mut World)
pub fn allow_ambiguous_resource<T: Resource>(&mut self, world: &mut World)
Ignore system order ambiguities caused by conflicts on Resource
s of type T
.
sourcepub fn iter_ignored_ambiguities(
&self
) -> impl Iterator<Item = &ComponentId> + '_
pub fn iter_ignored_ambiguities( &self ) -> impl Iterator<Item = &ComponentId> + '_
Iterate through the ComponentId
’s that will be ignored.
sourcepub fn print_ignored_ambiguities(&self, components: &Components)
pub fn print_ignored_ambiguities(&self, components: &Components)
Prints the names of the components and resources with info
May panic or retrieve incorrect names if Components
is not from the same
world
sourcepub fn add_systems<M>(
&mut self,
schedule: impl ScheduleLabel,
systems: impl IntoSystemConfigs<M>
) -> &mut Self
pub fn add_systems<M>( &mut self, schedule: impl ScheduleLabel, systems: impl IntoSystemConfigs<M> ) -> &mut Self
Adds one or more systems to the Schedule
matching the provided ScheduleLabel
.
sourcepub fn configure_sets(
&mut self,
schedule: impl ScheduleLabel,
sets: impl IntoSystemSetConfigs
) -> &mut Self
pub fn configure_sets( &mut self, schedule: impl ScheduleLabel, sets: impl IntoSystemSetConfigs ) -> &mut Self
Configures a collection of system sets in the provided schedule, adding any sets that do not exist.
sourcepub fn ignore_ambiguity<M1, M2, S1, S2>(
&mut self,
schedule: impl ScheduleLabel,
a: S1,
b: S2
) -> &mut Selfwhere
S1: IntoSystemSet<M1>,
S2: IntoSystemSet<M2>,
pub fn ignore_ambiguity<M1, M2, S1, S2>(
&mut self,
schedule: impl ScheduleLabel,
a: S1,
b: S2
) -> &mut Selfwhere
S1: IntoSystemSet<M1>,
S2: IntoSystemSet<M2>,
Suppress warnings and errors that would result from systems in these sets having ambiguities
(conflicting access but indeterminate order) with systems in set
.
When possible, do this directly in the .add_systems(Update, a.ambiguous_with(b))
call.
However, sometimes two independent plugins A
and B
are reported as ambiguous, which you
can only suppress as the consumer of both.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Schedules
impl !RefUnwindSafe for Schedules
impl Send for Schedules
impl Sync for Schedules
impl Unpin for Schedules
impl !UnwindSafe for Schedules
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.