Skip to main content

SimpleScheduler

Struct SimpleScheduler 

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

Scheduler for the Soroban-first SimpleWorld runtime.

Systems can be grouped into stages and ordered relative to each other using SystemConfig::before() and SystemConfig::after(). Each system receives a deferred CommandQueue through SystemContext; queued commands are applied after the system finishes.

§Example

use cougr_core::scheduler::{ScheduleStage, SimpleScheduler, SystemConfig};
use cougr_core::simple_world::SimpleWorld;
use soroban_sdk::{symbol_short, Bytes, Env};

fn physics_system(world: &mut SimpleWorld, env: &Env) {
    let entity = world.spawn_entity();
    world.add_component(entity, symbol_short!("physics"), Bytes::new(env));
}
fn scoring_system(world: &mut SimpleWorld, env: &Env) {
    let entity = world.spawn_entity();
    world.add_component(entity, symbol_short!("scoring"), Bytes::new(env));
}

let env = Env::default();
let mut world = SimpleWorld::new(&env);
let mut scheduler = SimpleScheduler::new();
scheduler.add_system("physics", physics_system);
scheduler.add_system_with_config(
    "scoring",
    scoring_system,
    SystemConfig::new()
        .in_stage(ScheduleStage::Update)
        .after("physics"),
);
scheduler.run_all(&mut world, &env).unwrap();
assert_eq!(scheduler.system_count(), 2);

Implementations§

Source§

impl SimpleScheduler

Source

pub fn new() -> Self

Source

pub fn add_system<F>(&mut self, name: &'static str, system: F)
where F: FnMut(&mut SimpleWorld, &Env) + 'static,

Add a world/env system to the Update stage.

Source

pub fn add_system_with_config<F>( &mut self, name: &'static str, system: F, config: SystemConfig, )
where F: FnMut(&mut SimpleWorld, &Env) + 'static,

Add a world/env system with explicit scheduling rules.

Source

pub fn add_system_in_stage<F>( &mut self, stage: ScheduleStage, name: &'static str, system: F, )
where F: FnMut(&mut SimpleWorld, &Env) + 'static,

Add a world/env system directly to a specific stage.

Source

pub fn add_context_system<F>(&mut self, name: &'static str, system: F)
where F: for<'w, 'e, 'c> FnMut(&mut SystemContext<'w, 'e, 'c>) + 'static,

Add a context-aware system to the Update stage.

Source

pub fn add_context_system_with_config<F>( &mut self, name: &'static str, system: F, config: SystemConfig, )
where F: for<'w, 'e, 'c> FnMut(&mut SystemContext<'w, 'e, 'c>) + 'static,

Add a context-aware system with explicit scheduling rules.

Source

pub fn add_context_system_in_stage<F>( &mut self, stage: ScheduleStage, name: &'static str, system: F, )
where F: for<'w, 'e, 'c> FnMut(&mut SystemContext<'w, 'e, 'c>) + 'static,

Add a context-aware system directly to a specific stage.

Source

pub fn add_simple_system<S>(&mut self, name: &'static str, system: S)
where S: AppSystem + 'static,

Add any pre-built runtime system to the default Update stage.

Source

pub fn add_simple_system_with_config<S>( &mut self, name: &'static str, system: S, config: SystemConfig, )
where S: AppSystem + 'static,

Add any pre-built runtime system with explicit scheduling rules.

Source

pub fn add_simple_system_in_stage<S>( &mut self, stage: ScheduleStage, name: &'static str, system: S, )
where S: AppSystem + 'static,

Add any pre-built runtime system directly to a specific stage.

Source

pub fn add_system_spec<S>(&mut self, spec: SystemSpec<S>)
where S: AppSystem + 'static,

Add a declarative runtime system spec.

Source

pub fn add_systems<G>(&mut self, group: G)
where G: SystemGroup,

Add one or more runtime systems using the modern declarative API.

Source

pub fn add_systems_in_stage<G>(&mut self, stage: ScheduleStage, group: G)
where G: SystemGroup,

Add one or more runtime systems while forcing them into a stage.

Source

pub fn configure_system( &mut self, name: &str, config: SystemConfig, ) -> Result<(), ScheduleError>

Update the scheduling config for an already-registered system.

Source

pub fn run_all( &mut self, world: &mut SimpleWorld, env: &Env, ) -> Result<(), ScheduleError>

Validate and execute the full schedule.

Source

pub fn run_stage( &mut self, stage: ScheduleStage, world: &mut SimpleWorld, env: &Env, ) -> Result<(), ScheduleError>

Validate and execute only a single stage.

Source

pub fn system_count(&self) -> usize

Returns the number of registered systems.

Source

pub fn system_names(&self) -> Vec<&str>

Returns the system names in registration order.

Source

pub fn stage_system_names( &self, stage: ScheduleStage, ) -> Result<Vec<&str>, ScheduleError>

Returns the system names assigned to a given stage in execution order.

Trait Implementations§

Source§

impl Default for SimpleScheduler

Source§

fn default() -> Self

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, C> Compare<&T> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare(&self, a: &&T, b: &&T) -> Result<Ordering, <C as Compare<&T>>::Error>

Source§

impl<T, U, E, C> Compare<(T, U)> for C
where C: Compare<T, Error = E, Error = E> + Compare<U>,

Source§

type Error = E

Source§

fn compare( &self, a: &(T, U), b: &(T, U), ) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

Source§

impl<T, U, V, E, C> Compare<(T, U, V)> for C
where C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,

Source§

impl<T, U, V, W, E, C> Compare<(T, U, V, W)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W>,

Source§

impl<T, U, V, W, X, E, C> Compare<(T, U, V, W, X)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W> + Compare<X>,

Source§

impl<T, C> Compare<Box<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Box<T>, b: &Box<T>, ) -> Result<Ordering, <C as Compare<Box<T>>>::Error>

Source§

impl<T, C> Compare<Option<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Option<T>, b: &Option<T>, ) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

Source§

impl<T, C> Compare<Rc<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Rc<T>, b: &Rc<T>, ) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

Source§

impl<T, C> Compare<Vec<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Vec<T>, b: &Vec<T>, ) -> Result<Ordering, <C as Compare<Vec<T>>>::Error>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<E, T, U> IntoVal<E, T> for U
where E: Env, T: FromVal<E, U>,

Source§

fn into_val(&self, e: &E) -> T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<E, T, U> TryIntoVal<E, T> for U
where E: Env, T: TryFromVal<E, U>,

Source§

type Error = <T as TryFromVal<E, U>>::Error

Source§

fn try_into_val(&self, env: &E) -> Result<T, <U as TryIntoVal<E, T>>::Error>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V