Struct embedded_spi::wrapper::Wrapper

pub struct Wrapper<Spi, SpiError, Pin, PinError> { /* fields omitted */ }

Wrapper wraps an Spi and Pin object to support transactions

Methods

impl<Spi, SpiError, Pin, PinError> Wrapper<Spi, SpiError, Pin, PinError> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>,
    Pin: OutputPin<Error = PinError>, 

pub fn new(spi: Spi, cs: Pin) -> Self

pub fn check_error(&mut self) -> Result<(), Error<SpiError, PinError>>

Check the internal error state of the peripheral This provides a mechanism to retrieve the rust error if an error occurs during an FFI call, and clears the internal error state

impl<Spi, SpiError, Pin, PinError> Wrapper<Spi, SpiError, Pin, PinError> where
    Spi: Transfer<u8, Error = SpiError> + Write<u8, Error = SpiError>,
    Pin: OutputPin<Error = PinError>, 

pub fn to_c_ptr(&mut self) -> *mut c_void

Generate a C void pointer that can be re-cast into this object

pub extern "C" fn spi_write(
    ctx: *mut c_void,
    prefix: *mut u8,
    prefix_len: u16,
    data: *mut u8,
    data_len: u16
) -> isize

C FFI compatible spi_write function for dependency injection

pub extern "C" fn spi_read(
    ctx: *mut c_void,
    prefix: *mut u8,
    prefix_len: u16,
    data: *mut u8,
    data_len: u16
) -> isize

C FFI compatible spi_read function for dependency injection

Trait Implementations

impl<Spi: PartialEq, SpiError: PartialEq, Pin: PartialEq, PinError: PartialEq> PartialEq<Wrapper<Spi, SpiError, Pin, PinError>> for Wrapper<Spi, SpiError, Pin, PinError>

fn eq(&self, other: &Wrapper<Spi, SpiError, Pin, PinError>) -> bool

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

fn ne(&self, other: &Wrapper<Spi, SpiError, Pin, PinError>) -> bool

This method tests for !=.

impl<Spi: Debug, SpiError: Debug, Pin: Debug, PinError: Debug> Debug for Wrapper<Spi, SpiError, Pin, PinError>

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

Formats the value using the given formatter.

impl<Spi: Clone, SpiError: Clone, Pin: Clone, PinError: Clone> Clone for Wrapper<Spi, SpiError, Pin, PinError>

fn clone(&self) -> Wrapper<Spi, SpiError, Pin, PinError>

Returns a copy of the value.

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

Performs copy-assignment from source.