Struct RecordingActuator 

pub struct RecordingActuator<C> { /* private fields */ }

An actuator that records every command instead of driving hardware.

This stands in for a relay, a valve, or a motor in a hardware-free test: it implements the core [Actuator] trait and keeps an ordered log of every command applied to it, so a test can assert what a control loop decided to do. Take a log handle before moving the actuator into a Node, then read the commands back through it afterwards.

Examples

use pamoja_core::Actuator;
use pamoja_sim::RecordingActuator;

let mut relay = RecordingActuator::new();
let log = relay.log();

relay.apply(true).await?;
relay.apply(false).await?;

assert_eq!(log.commands(), vec![true, false]);

Implementations

impl<C> RecordingActuator<C>

pub fn new() -> Self

Creates an actuator with an empty command log.

Returns

A recording actuator.

pub fn log(&self) -> ActuatorLog<C>

Returns a handle that reads this actuator’s command log.

The handle shares the same underlying log, so commands applied after it is taken are still visible through it.

Returns

An ActuatorLog over the same recorded commands.

Trait Implementations

impl<C> Actuator for RecordingActuator<C>

type Command = C

The command accepted by a single application, for example a setpoint.

async fn apply(&mut self, command: C) -> Result<()>

Applies a command to the actuator.

impl<C: Clone> Clone for RecordingActuator<C>

fn clone(&self) -> RecordingActuator<C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug> Debug for RecordingActuator<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C> Default for RecordingActuator<C>

fn default() -> Self

Returns the “default value” for a type.