Struct Pipe

pub struct Pipe<T, S, F> { /* private fields */ }

Implementations

impl<T, S, F> Pipe<T, S, F>

pub fn new(callback: F) -> Self

Trait Implementations

impl<T, S, F> Codelet for Pipe<T, S, F>

where T: Send + Sync, S: Clone + Send + Sync, F: FnMut(T) -> S + Send,

type Status = DefaultStatus

Status code used to indicate health of codelet

type Config = PipeConfig

Type used for configuration

type Rx = DoubleBufferRx<T>

Type holding all receiving (RX) endpoints

type Tx = DoubleBufferTx<S>

Type holding all transmitting (TX) endpoints

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

Constructs channel bundles

fn start( &mut self, _cx: &Context<'_, Self>, rx: &mut Self::Rx, _tx: &mut Self::Tx, ) -> Outcome

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

fn step( &mut self, ctx: &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 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.