logo
pub enum ShouldRun {
    Yes,
    No,
    YesAndCheckAgain,
    NoAndCheckAgain,
}
Expand description

Determines whether a system should be executed or not, and how many times it should be ran each time the stage is executed.

A stage will loop over its run criteria and systems until no more systems need to be executed and no more run criteria need to be checked.

  • Any systems with run criteria that returns Yes will be ran exactly one more time during the stage’s execution that tick.
  • Any systems with run criteria that returns No are not ran for the rest of the stage’s execution that tick.
  • Any systems with run criteria that returns YesAndCheckAgain will be ran during this iteration of the loop. After all the systems that need to run are ran, that criteria will be checked again.
  • Any systems with run criteria that returns NoAndCheckAgain will not be ran during this iteration of the loop. After all the systems that need to run are ran, that criteria will be checked again.

Variants

Yes

Yes, the system should run one more time this tick.

No

No, the system should not run for the rest of this tick.

YesAndCheckAgain

Yes, the system should run, and after all systems in this stage have run, the criteria should be checked again. This will cause the stage to loop over the remaining systems and criteria this tick until they no longer need to be checked.

NoAndCheckAgain

No, the system should not run right now, but after all systems in this stage have run, the criteria should be checked again. This will cause the stage to loop over the remaining systems and criteria this tick until they no longer need to be checked.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

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

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Compare self to key and return true if they are equal.

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more