pub struct Schedule { /* private fields */ }
Expand description
A container of Stage
s set to be run in a linear order.
Since Schedule
implements the Stage
trait, it can be inserted into another schedule.
In this way, the properties of the child schedule can be set differently from the parent.
For example, it can be set to run only once during app execution, while the parent schedule
runs indefinitely.
Implementations§
§impl Schedule
impl Schedule
pub fn with_stage<S>(self, label: impl StageLabel, stage: S) -> Schedulewhere
S: Stage,
pub fn with_stage<S>(self, label: impl StageLabel, stage: S) -> Schedulewhere
S: Stage,
Similar to add_stage
, but it also returns itself.
pub fn with_stage_after<S>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Schedulewhere
S: Stage,
pub fn with_stage_after<S>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Schedulewhere
S: Stage,
Similar to add_stage_after
, but it also returns itself.
pub fn with_stage_before<S>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Schedulewhere
S: Stage,
pub fn with_stage_before<S>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Schedulewhere
S: Stage,
Similar to add_stage_before
, but it also returns itself.
pub fn with_run_criteria<S, P>(self, system: S) -> Schedulewhere
S: IntoSystem<(), ShouldRun, P>,
pub fn with_system_in_stage<Params>(
self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> Schedule
pub fn with_system_in_stage<Params>(
self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> Schedule
Similar to add_system_to_stage
, but it also returns itself.
pub fn set_run_criteria<S, P>(&mut self, system: S) -> &mut Schedulewhere
S: IntoSystem<(), ShouldRun, P>,
pub fn add_stage<S>(&mut self, label: impl StageLabel, stage: S) -> &mut Schedulewhere
S: Stage,
pub fn add_stage<S>(&mut self, label: impl StageLabel, stage: S) -> &mut Schedulewhere
S: Stage,
Adds the given stage
at the last position of the schedule.
Example
// Define a new label for the stage.
#[derive(StageLabel)]
struct MyStage;
// Add a stage with that label to the schedule.
schedule.add_stage(MyStage, SystemStage::parallel());
pub fn add_stage_after<S>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Schedulewhere
S: Stage,
pub fn add_stage_after<S>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Schedulewhere
S: Stage,
Adds the given stage
immediately after the target
stage.
Example
// Define a new label for the stage.
#[derive(StageLabel)]
struct NewStage;
// Add a stage with that label to the schedule.
schedule.add_stage_after(TargetStage, NewStage, SystemStage::parallel());
pub fn add_stage_before<S>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Schedulewhere
S: Stage,
pub fn add_stage_before<S>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Schedulewhere
S: Stage,
Adds the given stage
immediately before the target
stage.
Example
// Define a new, private label for the stage.
#[derive(StageLabel)]
struct NewStage;
// Add a stage with that label to the schedule.
schedule.add_stage_before(TargetStage, NewStage, SystemStage::parallel());
pub fn add_system_to_stage<Params>(
&mut self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> &mut Schedule
pub fn add_system_to_stage<Params>(
&mut self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> &mut Schedule
Adds the given system
to the stage identified by stage_label
.
Example
schedule.add_system_to_stage(MyStage, my_system);
pub fn add_system_set_to_stage(
&mut self,
stage_label: impl StageLabel,
system_set: SystemSet
) -> &mut Schedule
pub fn add_system_set_to_stage(
&mut self,
stage_label: impl StageLabel,
system_set: SystemSet
) -> &mut Schedule
Adds the given system_set
to the stage identified by stage_label
.
Example
schedule.add_system_set_to_stage(
MyStage,
SystemSet::new()
.with_system(system_a)
.with_system(system_b)
.with_system(system_c)
);
pub fn stage<T, F>(
&mut self,
stage_label: impl StageLabel,
func: F
) -> &mut Schedulewhere
T: Stage,
F: FnOnce(&mut T) -> &mut T,
pub fn stage<T, F>(
&mut self,
stage_label: impl StageLabel,
func: F
) -> &mut Schedulewhere
T: Stage,
F: FnOnce(&mut T) -> &mut T,
Fetches the Stage
of type T
marked with label
, then executes the provided
func
passing the fetched stage to it as an argument.
The func
argument should be a function or a closure that accepts a mutable reference
to a struct implementing Stage
and returns the same type. That means that it should
also assume that the stage has already been fetched successfully.
Example
schedule.stage(MyStage, |stage: &mut SystemStage| {
stage.add_system(my_system)
});
Panics
Panics if label
refers to a non-existing stage, or if it’s not of type T
.
pub fn get_stage<T>(&self, stage_label: impl StageLabel) -> Option<&T>where
T: Stage,
pub fn get_stage<T>(&self, stage_label: impl StageLabel) -> Option<&T>where
T: Stage,
Returns a shared reference to the stage identified by label
, if it exists.
If the requested stage does not exist, None
is returned instead.
Example
let stage = schedule.get_stage::<SystemStage>(MyStage).unwrap();
pub fn get_stage_mut<T>(
&mut self,
stage_label: impl StageLabel
) -> Option<&mut T>where
T: Stage,
pub fn get_stage_mut<T>(
&mut self,
stage_label: impl StageLabel
) -> Option<&mut T>where
T: Stage,
Returns a unique, mutable reference to the stage identified by label
, if it exists.
If the requested stage does not exist, None
is returned instead.
Example
let stage = schedule.get_stage_mut::<SystemStage>(MyStage).unwrap();
pub fn run_once(&mut self, world: &mut World)
pub fn run_once(&mut self, world: &mut World)
Executes each Stage
contained in the schedule, one at a time.
pub fn iter_stages(
&self
) -> impl Iterator<Item = (StageLabelId, &(dyn Stage + 'static))>
pub fn iter_stages(
&self
) -> impl Iterator<Item = (StageLabelId, &(dyn Stage + 'static))>
Iterates over all of schedule’s stages and their labels, in execution order.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Schedule
impl Send for Schedule
impl Sync for Schedule
impl Unpin for Schedule
impl !UnwindSafe for Schedule
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read more§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more§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. Read more§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. Read more§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World