Struct ParameterGate

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

A gate can be configured via a (mutable) parameter to either forward all received messages (open), or drop all received messages (closed).

Trait Implementations

impl<T> Codelet for ParameterGate<T>

where T: Send + Sync + Clone,

type Status = ParameterGateStatus

Status code used to indicate health of codelet

type Config = ParameterGateConfig

Type used for configuration

type Rx = DoubleBufferRx<T>

Type holding all receiving (RX) endpoints

type Tx = DoubleBufferTx<T>

Type holding all transmitting (TX) endpoints

type Signals = ()

Type storing the codelet’s signals

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

Constructs channel bundles

fn step( &mut self, cx: Context<'_, Self>, rx: &mut Self::Rx, tx: &mut Self::Tx, ) -> Result<ParameterGateStatus>

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> Default for ParameterGate<T>

fn default() -> Self

Returns the “default value” for a type.