Struct paddle::LoadScheduler

pub struct LoadScheduler { /* fields omitted */ }

Helper object to manage resource loading.

Usage

1. Register a set of futures that will load the resources
2. Call `attach_to_domain`, which will consume the `LoadScheduler`
3. (optional)  Subscribe to `LoadingProgress` event
4. Subscribe to `LoadingDone` event and extract resources from the `LoadedData` object in the domain

Nuts Events published

LoadingProgress: Published on every resource that has been loaded, including the relative progress and the message of a currently loaded resource

LoadingDone: Published once when the last resource finished loading

Implementations

impl LoadScheduler

pub fn new() -> Self

pub fn attach_to_domain(self)

pub fn register<T: Sized + 'static, F: Future<Output = T> + 'static>(
    &mut self,
    future: F,
    msg: &'static str
)

Register a future to be loaded.

The future will be spawned and automatically reporting to the load scheduler is set up for afterwards.

pub fn register_vec<T: Sized + 'static, F: Future<Output = T> + 'static>(
    &mut self,
    future_vec: Vec<F>,
    msg: &'static str
)

Same as register but for a vector of futures.

The LoadedData will contain a vector with the values loaded in the exact same order.

pub fn register_manually_reported<T: Any>(&mut self, msg: &'static str)

Register a data type that needs to be loaded.

When this function is used, the data has to be manually added using add_progress. It can then be later extracted from LoadedData just like data registers as futures.

This is useful when some of data to load does not use a future.

pub fn with<T: Any, F: Future<Output = T> + 'static>(
    self,
    future: F,
    msg: &'static str
) -> Self

Builder pattern for register

pub fn with_vec<T: Any, F: Future<Output = T> + 'static>(
    self,
    futures: Vec<F>,
    msg: &'static str
) -> Self

Builder pattern for register_vec

pub fn with_manually_reported<T: Any>(self, msg: &'static str) -> Self

Builder pattern for register_manually_reported

pub fn add_progress_boxed(&mut self, loaded: Box<dyn Any>)

Update the progress tracking with a new resource

pub fn add_progress<T: Any>(&mut self, loaded: T)

Update the progress tracking with a new resource. The resource will be put in a box, so if you already have one, just use add_progress_boxed to avoid an extra reboxing.

pub fn add_vec_progress(&mut self, loaded: Box<dyn Any>, index: usize)

Update the progress tracking with a new resource

pub fn progress(&self) -> f32

Reports relative loading progress between 0.0 and 1.0

pub fn done(&self) -> bool

Returns true iff all registered resources are fully loaded.

pub fn waiting_for(&self) -> Option<&'static str>

If there are resources left to be loaded, returns the loading message of one of them.

pub fn finish(&mut self) -> LoadedData

Trait Implementations

impl Default for LoadScheduler

pub fn default() -> LoadScheduler

Returns the "default value" for a type.