Struct flipdot_testing::VirtualSignBus

pub struct VirtualSignBus<'a> { /* fields omitted */ }

Mock implementation of a bus containing one or more signs.

The bus is populated with one or more VirtualSigns which actually implement the sign protocol. VirtualSignBus forwards messages to each virtual sign in turn until one of them handles it.

While most likely not a 100% accurate implementation of the protocol, it is sufficient for interacting with a real ODK.

Messages and responses are logged using the log crate for debugging purposes. Consuming binaries typically use the env_logger crate and can be run with the RUST_LOG=debug environment variable to watch the bus messages go by.

Examples

use flipdot_serial::SerialSignBus;
use flipdot_testing::{Address, Odk, VirtualSign, VirtualSignBus};

let bus = VirtualSignBus::new(vec![VirtualSign::new(Address(3))]);
let port = serial::open("/dev/ttyUSB0")?;
let mut odk = Odk::try_new(port, bus)?;
loop {
    // VirtualSignBus processes the messsages from the real ODK over serial.
    odk.process_message()?;
}

Implementations

impl<'a> VirtualSignBus<'a>

pub fn new<I>(signs: I) -> Self where
    I: IntoIterator<Item = VirtualSign<'a>>, 

Creates a new VirtualSignBus with the specified virtual signs.

Examples

let bus = VirtualSignBus::new(vec![VirtualSign::new(Address(3))]);
let port = serial::open("COM3")?;
let odk = Odk::try_new(port, bus)?;

pub fn sign(&self, index: usize) -> &VirtualSign<'a>

Returns a reference to the VirtualSign at a specific index matching the original order passed to new.

Useful when writing tests in order to verify properties of an individual sign.

Examples

let signs = vec![VirtualSign::new(Address(5)), VirtualSign::new(Address(16))];
let bus = VirtualSignBus::new(signs);
let second_sign = bus.sign(1);
assert_eq!(Address(16), second_sign.address());

Trait Implementations

impl<'a> Clone for VirtualSignBus<'a>

fn clone(&self) -> VirtualSignBus<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for VirtualSignBus<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for VirtualSignBus<'a>

impl<'a> Hash for VirtualSignBus<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<VirtualSignBus<'a>> for VirtualSignBus<'a>

fn eq(&self, other: &VirtualSignBus<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VirtualSignBus<'a>) -> bool

This method tests for !=.

impl SignBus for VirtualSignBus<'_>

fn process_message<'a>(
    &mut self,
    message: Message<'_>
) -> Result<Option<Message<'a>>, Box<dyn Error + Send + Sync>>

Handles a bus message by trying each sign in turn to see if it can handle it (i.e. returns a Some response).

impl<'a> StructuralEq for VirtualSignBus<'a>

impl<'a> StructuralPartialEq for VirtualSignBus<'a>