Struct embedded_hal_async::spi::ExclusiveDevice

source ·

pub struct ExclusiveDevice<BUS, CS> { /* private fields */ }

Expand description

SpiDevice implementation with exclusive access to the bus (not shared).

This is the most straightforward way of obtaining an SpiDevice from an SpiBus, ideal for when no sharing is required (only one SPI device is present on the bus).

Implementations

source

impl<BUS, CS> ExclusiveDevice<BUS, CS>

source

pub fn new(bus: BUS, cs: CS) -> Self

Create a new ExclusiveDevice

Trait Implementations

source

impl<BUS, CS> ErrorType for ExclusiveDevice<BUS, CS>where
BUS: ErrorType,
CS: OutputPin,

type Error = ExclusiveDeviceError<<BUS as ErrorType>::Error, <CS as ErrorType>::Error>

Error type

source

impl<BUS, CS> SpiDevice for ExclusiveDevice<BUS, CS>where
BUS: SpiBusFlush,
CS: OutputPin,

type Bus = BUS

SPI Bus type for this device.

source

fn transaction<R>(
&mut self,
f: impl FnOnce(&mut Self::Bus) -> Result<R, <Self::Bus as ErrorType>::Error>
) -> Result<R, Self::Error>

Perform a transaction against the device. Read more

source

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

Do a write within a transaction. Read more

source

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

Do a read within a transaction. Read more

source

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

Do a transfer within a transaction. Read more

source

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

Do an in-place transfer within a transaction. Read more

source

impl<BUS, CS> SpiDevice for ExclusiveDevice<BUS, CS>where
BUS: SpiBusFlush,
CS: OutputPin,

type Bus = BUS

SPI Bus type for this device.

source

async fn transaction<R, F, Fut>(&mut self, f: F) -> Result<R, Self::Error>where
F: FnOnce(*mut Self::Bus) -> Fut,
Fut: Future<Output = Result<R, <Self::Bus as ErrorType>::Error>>,

Perform a transaction against the device. Read more

source

async fn read<'a, Word>(
 &'a mut self,
 buf: &'a mut [Word]
) -> Result<(), Self::Error>where
 Self::Bus: SpiBusRead<Word>,
 Word: Copy + 'static,

Do a read within a transaction. Read more

source

async fn write<'a, Word>(
 &'a mut self,
 buf: &'a [Word]
) -> Result<(), Self::Error>where
 Self::Bus: SpiBusWrite<Word>,
 Word: Copy + 'static,

Do a write within a transaction. Read more

source

async fn transfer<'a, Word>(
 &'a mut self,
 read: &'a mut [Word],
 write: &'a [Word]
) -> Result<(), Self::Error>where
 Self::Bus: SpiBus<Word>,
 Word: Copy + 'static,

Do a transfer within a transaction. Read more

source

async fn transfer_in_place<'a, Word>(
 &'a mut self,
 buf: &'a mut [Word]
) -> Result<(), Self::Error>where
 Self::Bus: SpiBus<Word>,
 Word: Copy + 'static,

Do an in-place transfer within a transaction. Read more

Auto Trait Implementations

impl<BUS, CS> RefUnwindSafe for ExclusiveDevice<BUS, CS>where
BUS: RefUnwindSafe,
CS: RefUnwindSafe,

impl<BUS, CS> Send for ExclusiveDevice<BUS, CS>where
BUS: Send,
CS: Send,

impl<BUS, CS> Sync for ExclusiveDevice<BUS, CS>where
BUS: Sync,
CS: Sync,

impl<BUS, CS> Unpin for ExclusiveDevice<BUS, CS>where
BUS: Unpin,
CS: Unpin,

impl<BUS, CS> UnwindSafe for ExclusiveDevice<BUS, CS>where
BUS: UnwindSafe,
CS: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct embedded_hal_async::spi::ExclusiveDevice

Implementations

impl<BUS, CS> ExclusiveDevice<BUS, CS>

pub fn new(bus: BUS, cs: CS) -> Self

Trait Implementations

impl<BUS, CS> ErrorType for ExclusiveDevice<BUS, CS>where BUS: ErrorType, CS: OutputPin,

type Error = ExclusiveDeviceError<<BUS as ErrorType>::Error, <CS as ErrorType>::Error>

impl<BUS, CS> SpiDevice for ExclusiveDevice<BUS, CS>where BUS: SpiBusFlush, CS: OutputPin,

type Bus = BUS

fn transaction<R>( &mut self, f: impl FnOnce(&mut Self::Bus) -> Result<R, <Self::Bus as ErrorType>::Error>) -> Result<R, Self::Error>

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

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

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

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

impl<BUS, CS> SpiDevice for ExclusiveDevice<BUS, CS>where BUS: SpiBusFlush, CS: OutputPin,

type Bus = BUS

async fn transaction<R, F, Fut>(&mut self, f: F) -> Result<R, Self::Error>where F: FnOnce(*mut Self::Bus) -> Fut, Fut: Future<Output = Result<R, <Self::Bus as ErrorType>::Error>>,

async fn read<'a, Word>( &'a mut self, buf: &'a mut [Word]) -> Result<(), Self::Error>where Self::Bus: SpiBusRead<Word>, Word: Copy + 'static,

async fn write<'a, Word>( &'a mut self, buf: &'a [Word]) -> Result<(), Self::Error>where Self::Bus: SpiBusWrite<Word>, Word: Copy + 'static,

async fn transfer<'a, Word>( &'a mut self, read: &'a mut [Word], write: &'a [Word]) -> Result<(), Self::Error>where Self::Bus: SpiBus<Word>, Word: Copy + 'static,

async fn transfer_in_place<'a, Word>( &'a mut self, buf: &'a mut [Word]) -> Result<(), Self::Error>where Self::Bus: SpiBus<Word>, Word: Copy + 'static,

Auto Trait Implementations

impl<BUS, CS> RefUnwindSafe for ExclusiveDevice<BUS, CS>where BUS: RefUnwindSafe, CS: RefUnwindSafe,

impl<BUS, CS> Send for ExclusiveDevice<BUS, CS>where BUS: Send, CS: Send,

impl<BUS, CS> Sync for ExclusiveDevice<BUS, CS>where BUS: Sync, CS: Sync,

impl<BUS, CS> Unpin for ExclusiveDevice<BUS, CS>where BUS: Unpin, CS: Unpin,

impl<BUS, CS> UnwindSafe for ExclusiveDevice<BUS, CS>where BUS: UnwindSafe, CS: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<BUS, CS> ErrorType for ExclusiveDevice<BUS, CS>where
BUS: ErrorType,
CS: OutputPin,

impl<BUS, CS> SpiDevice for ExclusiveDevice<BUS, CS>where
BUS: SpiBusFlush,
CS: OutputPin,

fn transaction<R>(
&mut self,
f: impl FnOnce(&mut Self::Bus) -> Result<R, <Self::Bus as ErrorType>::Error>
) -> Result<R, Self::Error>

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

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

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

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

impl<BUS, CS> SpiDevice for ExclusiveDevice<BUS, CS>where
BUS: SpiBusFlush,
CS: OutputPin,

async fn transaction<R, F, Fut>(&mut self, f: F) -> Result<R, Self::Error>where
F: FnOnce(*mut Self::Bus) -> Fut,
Fut: Future<Output = Result<R, <Self::Bus as ErrorType>::Error>>,

async fn read<'a, Word>(
&'a mut self,
buf: &'a mut [Word]
) -> Result<(), Self::Error>where
Self::Bus: SpiBusRead<Word>,
Word: Copy + 'static,

async fn write<'a, Word>(
&'a mut self,
buf: &'a [Word]
) -> Result<(), Self::Error>where
Self::Bus: SpiBusWrite<Word>,
Word: Copy + 'static,

async fn transfer<'a, Word>(
&'a mut self,
read: &'a mut [Word],
write: &'a [Word]
) -> Result<(), Self::Error>where
Self::Bus: SpiBus<Word>,
Word: Copy + 'static,

async fn transfer_in_place<'a, Word>(
&'a mut self,
buf: &'a mut [Word]
) -> Result<(), Self::Error>where
Self::Bus: SpiBus<Word>,
Word: Copy + 'static,

impl<BUS, CS> RefUnwindSafe for ExclusiveDevice<BUS, CS>where
BUS: RefUnwindSafe,
CS: RefUnwindSafe,

impl<BUS, CS> Send for ExclusiveDevice<BUS, CS>where
BUS: Send,
CS: Send,

impl<BUS, CS> Sync for ExclusiveDevice<BUS, CS>where
BUS: Sync,
CS: Sync,

impl<BUS, CS> Unpin for ExclusiveDevice<BUS, CS>where
BUS: Unpin,
CS: Unpin,

impl<BUS, CS> UnwindSafe for ExclusiveDevice<BUS, CS>where
BUS: UnwindSafe,
CS: UnwindSafe,

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

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

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

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

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

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