Struct Buffer

pub struct Buffer<M> { /* private fields */ }

Stores all received messages in memory

Implementations

impl<M> Buffer<M>

pub fn shared_access(&self) -> Arc<RwLock<VecDeque<M>>>

Get shared access to stored messages

Trait Implementations

impl<M: Clone + Send + Sync> Codelet for Buffer<M>

type Status = DefaultStatus

Status code used to indicate health of codelet

type Config = BufferConfig

Type used for configuration

type Rx = DoubleBufferRx<M>

Type holding all receiving (RX) endpoints

type Tx = ()

Type holding all transmitting (TX) endpoints

type Signals = ()

Type storing the codelet’s signals

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

Constructs channel bundles

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

impl<M> Default for Buffer<M>

fn default() -> Self

Returns the “default value” for a type.