embedded_hal_bus::i2c

Struct CriticalSectionDevice

source
pub struct CriticalSectionDevice<'a, T> { /* private fields */ }
Expand description

critical-section-based shared bus I2c implementation.

Sharing is implemented with a critical-section Mutex. A critical section is taken for the entire duration of a transaction. This allows sharing a single bus across multiple threads (interrupt priority levels). The downside is critical sections typically require globally disabling interrupts, so CriticalSectionDevice will likely negatively impact real-time properties, such as interrupt latency. If you can, prefer using RefCellDevice instead, which does not require taking critical sections.

Implementations§

source§

impl<'a, T> CriticalSectionDevice<'a, T>

source

pub fn new(bus: &'a Mutex<RefCell<T>>) -> Self

Create a new CriticalSectionDevice.

Trait Implementations§

source§

impl<'a, T> ErrorType for CriticalSectionDevice<'a, T>
where T: I2c,

source§

type Error = <T as ErrorType>::Error

Error type
source§

impl<'a, T> I2c for CriticalSectionDevice<'a, T>
where T: I2c,

source§

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

Reads enough bytes from slave with address to fill read. Read more
source§

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

Writes bytes to slave with address address. Read more
source§

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

Writes bytes to slave with address address and then reads enough bytes to fill read in a single transaction. Read more
source§

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

Execute the provided operations on the I2C bus. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for CriticalSectionDevice<'a, T>

§

impl<'a, T> !RefUnwindSafe for CriticalSectionDevice<'a, T>

§

impl<'a, T> Send for CriticalSectionDevice<'a, T>
where T: Send,

§

impl<'a, T> Sync for CriticalSectionDevice<'a, T>
where T: Send,

§

impl<'a, T> Unpin for CriticalSectionDevice<'a, T>

§

impl<'a, T> !UnwindSafe for CriticalSectionDevice<'a, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.