Struct ScheduleGraph

pub struct ScheduleGraph {
    pub systems: Vec<SystemNode>,
    pub system_conditions: Vec<Vec<BoxedCondition>>,
    pub ambiguous_with_all: HashSet<NodeId>,
    /* private fields */
}

Metadata for a Schedule.

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

Fields

systems: Vec<SystemNode>

List of systems in the schedule

system_conditions: Vec<Vec<BoxedCondition>>

List of conditions for each system, in the same order as systems

ambiguous_with_all: HashSet<NodeId>

Nodes that are allowed to have ambiguous ordering relationship with any other systems.

Implementations

impl ScheduleGraph

pub fn new() -> Self

Creates an empty ScheduleGraph with default settings.

pub fn get_system_at(&self, id: NodeId) -> Option<&ScheduleSystem>

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

pub fn contains_set(&self, set: impl SystemSet) -> bool

Returns true if the given system set is part of the graph. Otherwise, returns false.

pub fn system_at(&self, id: NodeId) -> &ScheduleSystem

Returns the system at the given NodeId.

Panics if it doesn’t exist.

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

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

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

Returns the set at the given NodeId.

Panics if it doesn’t exist.

pub fn get_set_conditions_at(&self, id: NodeId) -> Option<&[BoxedCondition]>

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

pub fn set_conditions_at(&self, id: NodeId) -> &[BoxedCondition]

Returns the conditions for the set at the given NodeId.

Panics if it doesn’t exist.

pub fn systems( &self, ) -> impl Iterator<Item = (NodeId, &ScheduleSystem, &[BoxedCondition])>

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

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.

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.

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.

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.

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

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

pub fn build_schedule( &mut self, world: &mut World, 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

impl ScheduleGraph

pub fn topsort_graph( &self, graph: &DiGraph, report: ReportCycles, ) -> Result<Vec<NodeId>, ScheduleBuildError>

Tries to topologically sort graph.

If the graph is acyclic, returns Ok with the list of NodeId in a valid topological order. If the graph contains cycles, returns Err with the list of strongly-connected components that contain cycles (also in a valid topological order).

Errors

If the graph contain cycles, then an error is returned.

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

convert conflicts to human readable format

Trait Implementations

impl Default for ScheduleGraph

fn default() -> ScheduleGraph

Returns the “default value” for a type.