Struct Join

pub struct Join<T>(/* private fields */);

Join has multiple input channels and a single output channel. All messages received on any input channel are sent to the output channel. There is no particular guarantee on the order of messages on the output channel.

Trait Implementations

impl<T: Send + Sync + Clone> Codelet for Join<T>

type Status = DefaultStatus

Status code used to indicate health of codelet

type Config = JoinConfig

Type used for configuration

type Rx = JoinRx<T>

Type holding all receiving (RX) endpoints

type Tx = DoubleBufferTx<T>

Type holding all transmitting (TX) endpoints

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

Constructs channel bundles

fn step( &mut self, _: &Context<'_, Self>, rx: &mut Self::Rx, tx: &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.

impl<T: Send + Sync + Clone> Default for Join<T>

fn default() -> Self

Returns the “default value” for a type.