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
sourceimpl Schedule
impl Schedule
sourcepub fn with_stage<S: Stage>(self, label: impl StageLabel, stage: S) -> Self
pub fn with_stage<S: Stage>(self, label: impl StageLabel, stage: S) -> Self
Similar to add_stage
, but it also returns itself.
sourcepub fn with_stage_after<S: Stage>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Self
pub fn with_stage_after<S: Stage>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Self
Similar to add_stage_after
, but it also returns itself.
sourcepub fn with_stage_before<S: Stage>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Self
pub fn with_stage_before<S: Stage>(
self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> Self
Similar to add_stage_before
, but it also returns itself.
pub fn with_run_criteria<S: IntoSystem<(), ShouldRun, P>, P>(
self,
system: S
) -> Self
sourcepub fn with_system_in_stage<Params>(
self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> Self
pub fn with_system_in_stage<Params>(
self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> Self
Similar to add_system_to_stage
, but it also returns itself.
pub fn set_run_criteria<S: IntoSystem<(), ShouldRun, P>, P>(
&mut self,
system: S
) -> &mut Self
sourcepub fn add_stage<S: Stage>(
&mut self,
label: impl StageLabel,
stage: S
) -> &mut Self
pub fn add_stage<S: Stage>(
&mut self,
label: impl StageLabel,
stage: S
) -> &mut Self
Adds the given stage
at the last position of the schedule.
Example
schedule.add_stage("my_stage", SystemStage::parallel());
sourcepub fn add_stage_after<S: Stage>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Self
pub fn add_stage_after<S: Stage>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Self
Adds the given stage
immediately after the target
stage.
Example
schedule.add_stage_after("target_stage", "my_stage", SystemStage::parallel());
sourcepub fn add_stage_before<S: Stage>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Self
pub fn add_stage_before<S: Stage>(
&mut self,
target: impl StageLabel,
label: impl StageLabel,
stage: S
) -> &mut Self
Adds the given stage
immediately before the target
stage.
Example
schedule.add_stage_before("target_stage", "my_stage", SystemStage::parallel());
sourcepub fn add_system_to_stage<Params>(
&mut self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> &mut Self
pub fn add_system_to_stage<Params>(
&mut self,
stage_label: impl StageLabel,
system: impl IntoSystemDescriptor<Params>
) -> &mut Self
Adds the given system
to the stage identified by stage_label
.
Example
schedule.add_system_to_stage("my_stage", my_system);
sourcepub fn add_system_set_to_stage(
&mut self,
stage_label: impl StageLabel,
system_set: SystemSet
) -> &mut Self
pub fn add_system_set_to_stage(
&mut self,
stage_label: impl StageLabel,
system_set: SystemSet
) -> &mut Self
Adds the given system_set
to the stage identified by stage_label
.
Example
schedule.add_system_set_to_stage(
"my_stage",
SystemSet::new()
.with_system(system_a)
.with_system(system_b)
.with_system(system_c)
);
sourcepub fn stage<T: Stage, F: FnOnce(&mut T) -> &mut T>(
&mut self,
label: impl StageLabel,
func: F
) -> &mut Self
pub fn stage<T: Stage, F: FnOnce(&mut T) -> &mut T>(
&mut self,
label: impl StageLabel,
func: F
) -> &mut Self
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("my_stage", |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
.
sourcepub fn get_stage<T: Stage>(&self, label: &dyn StageLabel) -> Option<&T>
pub fn get_stage<T: Stage>(&self, label: &dyn StageLabel) -> Option<&T>
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>(&"my_stage").unwrap();
sourcepub fn get_stage_mut<T: Stage>(
&mut self,
label: &dyn StageLabel
) -> Option<&mut T>
pub fn get_stage_mut<T: Stage>(
&mut self,
label: &dyn StageLabel
) -> Option<&mut T>
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>(&"my_stage").unwrap();
sourcepub 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.
sourcepub fn iter_stages(&self) -> impl Iterator<Item = (StageLabelId, &dyn Stage)>
pub fn iter_stages(&self) -> impl Iterator<Item = (StageLabelId, &dyn Stage)>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert 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
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
sourceimpl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
sourcefn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more