Struct UnitBuilder

pub struct UnitBuilder<'a> { /* private fields */ }

A builder returned by StateUnits::add.

Implementations

impl UnitBuilder<'_>

pub fn depends_on(self, handle: &UnitHandle) -> Self

Adds handle as a dependency of this new unit.

Operations will be ordered to ensure that a dependency will stop after its dependants, and that it will reset or restore before its dependants.

pub fn dependency_of(self, handle: &UnitHandle) -> Self

Adds this new unit as a dependency of handle.

Operations will be ordered to ensure that a dependency will stop after its dependants, and that it will reset or restore before its dependants.

pub fn build(self, send: Sender<StateRequest>) -> Result<UnitHandle, NameInUse>

Adds a new state unit sending requests to send.

pub fn spawn<F, Fut>( self, spawner: impl Spawn, f: F, ) -> Result<SpawnedUnit<Fut::Output>, NameInUse>

where F: FnOnce(Receiver<StateRequest>) -> Fut, Fut: 'static + Send + Future, Fut::Output: 'static + Send,

Adds a unit as in Self::build, then spawns a task for running the unit.

The channel to receive state change requests is passed to f, which should return the future to evaluate to run the unit.

Trait Implementations

impl<'a> Debug for UnitBuilder<'a>

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

Formats the value using the given formatter.