Struct bevy_ecs::schedule::ScheduleGraph

source ·
pub struct ScheduleGraph { /* private fields */ }
Expand description

Metadata for a Schedule.

The order isn’t optimized; calling ScheduleGraph::build_schedule will return a SystemSchedule where the order is optimized for execution.

Implementations§

source§

impl ScheduleGraph

source

pub fn new() -> Self

Creates an empty ScheduleGraph with default settings.

source

pub fn get_system_at( &self, id: NodeId ) -> Option<&dyn System<In = (), Out = ()>>

Returns the system at the given NodeId, if it exists.

source

pub fn system_at(&self, id: NodeId) -> &dyn System<In = (), Out = ()>

Returns the system at the given NodeId.

Panics if it doesn’t exist.

source

pub fn get_set_at(&self, id: NodeId) -> Option<&dyn SystemSet>

Returns the set at the given NodeId, if it exists.

source

pub fn set_at(&self, id: NodeId) -> &dyn SystemSet

Returns the set at the given NodeId.

Panics if it doesn’t exist.

source

pub fn systems( &self ) -> impl Iterator<Item = (NodeId, &dyn System<In = (), Out = ()>, &[BoxedCondition])>

Returns an iterator over all systems in this schedule, along with the conditions for each system.

source

pub fn system_sets( &self ) -> impl Iterator<Item = (NodeId, &dyn SystemSet, &[BoxedCondition])>

Returns an iterator over all system sets in this schedule, along with the conditions for each system set.

source

pub fn hierarchy(&self) -> &Dag

Returns the Dag of the hierarchy.

The hierarchy is a directed acyclic graph of the systems and sets, where an edge denotes that a system or set is the child of another set.

source

pub fn dependency(&self) -> &Dag

Returns the Dag of the dependencies in the schedule.

Nodes in this graph are systems and sets, and edges denote that a system or set has to run before another system or set.

source

pub fn conflicting_systems(&self) -> &[(NodeId, NodeId, Vec<ComponentId>)]

Returns the list of systems that conflict with each other, i.e. have ambiguities in their access.

If the Vec<ComponentId> is empty, the systems conflict on World access. Must be called after ScheduleGraph::build_schedule to be non-empty.

source

pub fn initialize(&mut self, world: &mut World)

Initializes any newly-added systems and conditions by calling System::initialize

source

pub fn build_schedule( &mut self, components: &Components, schedule_label: InternedScheduleLabel, ignored_ambiguities: &BTreeSet<ComponentId> ) -> Result<SystemSchedule, ScheduleBuildError>

Build a SystemSchedule optimized for scheduler access from the ScheduleGraph.

This method also

  • checks for dependency or hierarchy cycles
  • checks for system access conflicts and reports ambiguities
source§

impl ScheduleGraph

source

pub fn conflicts_to_string<'a>( &'a self, ambiguities: &'a [(NodeId, NodeId, Vec<ComponentId>)], components: &'a Components ) -> impl Iterator<Item = (String, String, Vec<&str>)> + 'a

convert conflicts to human readable format

Trait Implementations§

source§

impl Default for ScheduleGraph

source§

fn default() -> ScheduleGraph

Returns the “default value” for a type. Read more

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 + Sync + Send>

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> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
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>,

§

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>,

§

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> ConditionalSend for T
where T: Send,