Skip to main content

SystemDescriptor

Struct SystemDescriptor 

Source
pub struct SystemDescriptor { /* private fields */ }
Expand description

Encapsulates a system and information on when it run in a SystemStage.

Systems can be inserted into 4 different groups within the stage:

  • Parallel, accepts non-exclusive systems.
  • At start, accepts exclusive systems; runs before parallel systems.
  • Before commands, accepts exclusive systems; runs after parallel systems, but before their command buffers are applied.
  • At end, accepts exclusive systems; runs after parallel systems’ command buffers have been applied.

Systems can have one or more labels attached to them; other systems in the same group can then specify that they have to run before or after systems with that label using the before and after methods.

§Example

#[derive(SystemLabel, Debug, Clone, PartialEq, Eq, Hash)]
struct Something;

SystemStage::parallel()
    .with_system(do_something.label(Something))
    .with_system(do_the_other_thing.after(Something))
    .with_system(do_something_else.at_end());

Trait Implementations§

Source§

impl Debug for SystemDescriptor

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl IntoSystemDescriptor<()> for SystemDescriptor

Source§

fn with_run_criteria<Marker>( self, run_criteria: impl IntoRunCriteria<Marker>, ) -> SystemDescriptor

Assigns a run criteria to the system. Can be a new descriptor or a label of a run criteria defined elsewhere.
Source§

fn label(self, label: impl SystemLabel) -> SystemDescriptor

Assigns a label to the system; there can be more than one, and it doesn’t have to be unique.
Source§

fn before<Marker>(self, label: impl AsSystemLabel<Marker>) -> SystemDescriptor

Specifies that the system should run before systems with the given label.
Source§

fn after<Marker>(self, label: impl AsSystemLabel<Marker>) -> SystemDescriptor

Specifies that the system should run after systems with the given label.
Source§

fn ambiguous_with<Marker>( self, label: impl AsSystemLabel<Marker>, ) -> SystemDescriptor

Marks this system as ambiguous with any system with the specified label. This means that execution order between these systems does not matter, which allows some warnings to be silenced.
Source§

fn ignore_all_ambiguities(self) -> SystemDescriptor

Specifies that this system should opt out of execution order ambiguity detection.
Source§

fn at_start(self) -> SystemDescriptor

Specifies that the system should run with other exclusive systems at the start of stage.
Source§

fn before_commands(self) -> SystemDescriptor

Specifies that the system should run with other exclusive systems after the parallel systems and before command buffer application.
Source§

fn at_end(self) -> SystemDescriptor

Specifies that the system should run with other exclusive systems at the end of stage.
Source§

fn into_descriptor(self) -> SystemDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Event for T
where T: Send + Sync + 'static,