Struct Terminator

pub struct Terminator { /* private fields */ }

Terminates after certain number of steps.

Implementations

impl Terminator

pub fn new(tx_control: SyncSender<RuntimeControl>) -> Self

Trait Implementations

impl Codelet for Terminator

type Status = DefaultStatus

Status code used to indicate health of codelet

type Config = usize

Type used for configuration

type Rx = ()

Type holding all receiving (RX) endpoints

type Tx = ()

Type holding all transmitting (TX) endpoints

fn build_bundles(_: &Self::Config) -> (Self::Rx, Self::Tx)

Constructs channel bundles

fn step( &mut self, cx: &Context<'_, Self>, _: &mut Self::Rx, _: &mut Self::Tx, ) -> Outcome

Step is executed periodically after the codelet is started and while it is not paused.

fn start( &mut self, _cx: &Context<'_, Self>, _rx: &mut Self::Rx, _tx: &mut Self::Tx, ) -> Result<Self::Status, Report>

Start is guaranteed to be called first. Start may be called again after stop was called.

fn stop( &mut self, _cx: &Context<'_, Self>, _rx: &mut Self::Rx, _tx: &mut Self::Tx, ) -> Result<Self::Status, Report>

Stop is guaranteed to be called at the end if start was called.

fn pause(&mut self) -> Result<Self::Status, Report>

Pause may be called to suspend stepping.

fn resume(&mut self) -> Result<Self::Status, Report>

Resume is called to resume stepping. Note that stop may also be called while the codelet is paused to stop the codelet completely instead of resuming stepping.