Enum tuig::ControlFlow

pub enum ControlFlow {
    Continue,
    Kill,
    Handle(WaitHandle),
    Time(Instant),
}

What should happen to an Agent after it finishes reacting to Messages.

This only says when Agent::react should start being called again. The associated agent won’t skip a round it should have seen, but it may see rounds it wasn’t supposed to. Treat this like an easy optimization: if you report it accurately, you can save the engine a bit of time when it processes messages.

Variants

Continue

Stay awake for next round.

Kill

Stop updating this agent forever and (eventually) destroy it.

Handle(WaitHandle)

Sleep until the handle gets woken up.

Time(Instant)

Sleep until the given time.

Implementations

impl ControlFlow

pub fn wait() -> (Self, WaitHandle)

Create a new ControlFlow::Handle, with its handle so something else can wake it.

pub fn sleep_until(time: Instant) -> Self

Create a new ControlFlow::Time, sleeping until the given time.

pub fn sleep_for(amt: Duration) -> Self

Create a new ControlFlow::Time, sleeping for a given duration from now.

pub fn is_ready(&self) -> bool

Check whether an agent which returned this is ready to start reacting again.

Trait Implementations

impl Clone for ControlFlow

fn clone(&self) -> ControlFlow

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ControlFlow

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

Formats the value using the given formatter.

impl PartialEq for ControlFlow

fn eq(&self, other: &ControlFlow) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ControlFlow

impl StructuralEq for ControlFlow

impl StructuralPartialEq for ControlFlow