Struct shared_bus::I2cProxy

pub struct I2cProxy<'a, M> { /* private fields */ }

Proxy type for I2C bus sharing.

The I2cProxy implements all (blocking) I2C traits so it can be passed to drivers instead of the bus instance. Internally, it holds reference to the bus via a mutex, ensuring that all accesses are strictly synchronized.

An I2cProxy is created by calling BusManager::acquire_i2c().

Trait Implementations

impl<'a, M: BusMutex> Clone for I2cProxy<'a, M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, M: Debug> Debug for I2cProxy<'a, M>

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

Formats the value using the given formatter.

impl<'a, M: BusMutex> ErrorType for I2cProxy<'a, M>where
    M::Bus: ErrorType,

type Error = <<M as BusMutex>::Bus as ErrorType>::Error

Error type

impl<'a, M: BusMutex> I2c<u8> for I2cProxy<'a, M>where
    M::Bus: I2c,

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

Reads enough bytes from slave with address to fill buffer

fn write(&mut self, address: u8, bytes: &[u8]) -> Result<(), Self::Error>

Writes bytes to slave with address address

fn write_iter<B>(&mut self, address: u8, bytes: B) -> Result<(), Self::Error>where
    B: IntoIterator<Item = u8>,

Writes bytes to slave with address address

fn write_read(
    &mut self,
    address: u8,
    bytes: &[u8],
    buffer: &mut [u8]
) -> Result<(), Self::Error>

Writes bytes to slave with address address and then reads enough bytes to fill buffer in a single transaction

fn write_iter_read<B>(
    &mut self,
    address: u8,
    bytes: B,
    buffer: &mut [u8]
) -> Result<(), Self::Error>where
    B: IntoIterator<Item = u8>,

Writes bytes to slave with address address and then reads enough bytes to fill buffer in a single transaction

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

Execute the provided operations on the I2C bus.

fn transaction_iter<'b, O>(
    &mut self,
    address: u8,
    operations: O
) -> Result<(), Self::Error>where
    O: IntoIterator<Item = Operation<'b>>,

Execute the provided operations on the I2C bus (iterator version).

impl<'a, M: BusMutex> Read<u8> for I2cProxy<'a, M>where
    M::Bus: Read,

type Error = <<M as BusMutex>::Bus as Read<u8>>::Error

Error type

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

Reads enough bytes from slave with address to fill buffer

impl<'a, M: BusMutex> Write<u8> for I2cProxy<'a, M>where
    M::Bus: Write,

type Error = <<M as BusMutex>::Bus as Write<u8>>::Error

Error type

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

Writes bytes to slave with address address

impl<'a, M: BusMutex> WriteRead<u8> for I2cProxy<'a, M>where
    M::Bus: WriteRead,

type Error = <<M as BusMutex>::Bus as WriteRead<u8>>::Error

Error type

fn write_read(
    &mut self,
    addr: u8,
    buffer_in: &[u8],
    buffer_out: &mut [u8]
) -> Result<(), Self::Error>

Writes bytes to slave with address address and then reads enough bytes to fill buffer in a single transaction