Type Alias embedded_hal_mock::eh1::spi::Mock

pub type Mock<W> = Generic<Transaction<W>>;

Available on crate feature eh1 only.

Mock SPI implementation

This supports the specification and checking of expectations to allow automated testing of SPI based drivers. Mismatches between expected and real SPI transactions will cause runtime assertions to assist with locating faults.

See the usage section in the module level docs for an example.

Aliased Type

struct Mock<W> { /* private fields */ }

Trait Implementations

impl<W> ErrorType for Mock<W>

where W: Copy + Debug + PartialEq,

type Error = ErrorKind

Error type.

impl<W> FullDuplex<W> for Mock<W>

where W: Copy + Debug + PartialEq,

fn write(&mut self, buffer: W) -> Result<(), Self::Error>

spi::FullDuplex implementation for Mock

This will call the nonblocking read/write primitives.

fn read(&mut self) -> Result<W, Self::Error>

spi::FullDuplex implementation for Mock

This will call the nonblocking read/write primitives.

impl<W> SpiBus<W> for Mock<W>

where W: Copy + 'static + Debug + PartialEq,

fn read(&mut self, buffer: &mut [W]) -> Result<(), Self::Error>

spi::Read implementation for Mock

This will cause an assertion if the read call does not match the next expectation

fn write(&mut self, buffer: &[W]) -> Result<(), Self::Error>

spi::Write implementation for Mock

This will cause an assertion if the write call does not match the next expectation

fn transfer_in_place(&mut self, buffer: &mut [W]) -> Result<(), Self::Error>

spi::TransferInplace implementation for Mock

This writes the provided response to the buffer and will cause an assertion if the written data does not match the next expectation

fn transfer(&mut self, read: &mut [W], write: &[W]) -> Result<(), Self::Error>

Write and read simultaneously. write is written to the slave on MOSI and words received on MISO are stored in read.

fn flush(&mut self) -> Result<(), Self::Error>

Wait until all operations have completed and the bus is idle.

impl<W> SpiBus<W> for Mock<W>

where W: Copy + 'static + Debug + PartialEq,

Available on crate feature embedded-hal-async only.

async fn transfer_in_place( &mut self, words: &mut [W] ) -> Result<(), Self::Error>

spi::TransferInplace implementation for Mock

This writes the provided response to the buffer and will cause an assertion if the written data does not match the next expectation

async fn read(&mut self, words: &mut [W]) -> Result<(), Self::Error>

Read words from the slave.

async fn write(&mut self, words: &[W]) -> Result<(), Self::Error>

Write words to the slave, ignoring all the incoming words.

async fn transfer( &mut self, read: &mut [W], write: &[W] ) -> Result<(), Self::Error>

Write and read simultaneously. write is written to the slave on MOSI and words received on MISO are stored in read.

async fn flush(&mut self) -> Result<(), Self::Error>

Wait until all operations have completed and the bus is idle.

impl<W> SpiDevice<W> for Mock<W>

where W: Copy + 'static + Debug + PartialEq,

fn transaction( &mut self, operations: &mut [Operation<'_, W>] ) -> Result<(), Self::Error>

spi::SpiDevice implementation for Mock

This writes the provided response to the buffer and will cause an assertion if the written data does not match the next expectation

fn read(&mut self, buf: &mut [Word]) -> Result<(), Self::Error>

Do a read within a transaction.

fn write(&mut self, buf: &[Word]) -> Result<(), Self::Error>

Do a write within a transaction.

fn transfer( &mut self, read: &mut [Word], write: &[Word] ) -> Result<(), Self::Error>

Do a transfer within a transaction.

fn transfer_in_place(&mut self, buf: &mut [Word]) -> Result<(), Self::Error>

Do an in-place transfer within a transaction.

impl<W> SpiDevice<W> for Mock<W>

where W: Copy + 'static + Debug + PartialEq,

Available on crate feature embedded-hal-async only.

async fn transaction( &mut self, operations: &mut [Operation<'_, W>] ) -> Result<(), Self::Error>

Perform a transaction against the device.

async fn read(&mut self, buf: &mut [Word]) -> Result<(), Self::Error>

Do a read within a transaction.

async fn write(&mut self, buf: &[Word]) -> Result<(), Self::Error>

Do a write within a transaction.

async fn transfer( &mut self, read: &mut [Word], write: &[Word] ) -> Result<(), Self::Error>

Do a transfer within a transaction.

async fn transfer_in_place( &mut self, buf: &mut [Word] ) -> Result<(), Self::Error>

Do an in-place transfer within a transaction.