Struct embedded_hal_mock::eh1::serial::Transaction

pub struct Transaction<Word> { /* private fields */ }

Available on crate feature eh1 only.

A serial transaction

Transactions can either be reads, writes, or flushes. A collection of transactions represent the expected operations that are performed on your serial device.

Example

use embedded_hal_mock::eh1::serial::{Mock, Transaction};

// We expect, in order,
// 1. A read that returns 0x23,
// 2. A write of [0x55, 0xAA]
// 3. A flush
let transactions = [
    Transaction::read(0x23),
    Transaction::write_many([0x55, 0xAA]),
    Transaction::flush(),
];

let mut serial = Mock::new(&transactions);

Implementations

impl<Word> Transaction<Word>

where Word: Clone,

pub fn read(word: Word) -> Self

Expect a serial read that returns the expected word

pub fn read_many<Ws>(words: Ws) -> Self

where Ws: AsRef<[Word]>,

Expect a serial read that returns the expected words

pub fn read_error(error: Error<ErrorKind>) -> Self

Expect a serial read that returns an error

pub fn write(word: Word) -> Self

Expect a serial write that transmits the specified word

pub fn write_many<Ws>(words: Ws) -> Self

where Ws: AsRef<[Word]>,

Expect a serial write that transmits the specified words

pub fn write_error(word: Word, error: Error<ErrorKind>) -> Self

Expect a serial write that returns an error after transmitting the specified word

pub fn flush() -> Self

Expect a caller to flush the serial buffers

pub fn flush_error(error: Error<ErrorKind>) -> Self

Expect a serial flush that returns an error