Struct embassy_stm32::can::CanRx
source · pub struct CanRx<'d, T: Instance> { /* private fields */ }Expand description
CAN driver, receive half.
Implementations§
source§impl<'d, T: Instance> CanRx<'d, T>
impl<'d, T: Instance> CanRx<'d, T>
sourcepub async fn read(&mut self) -> Result<Envelope, BusError>
pub async fn read(&mut self) -> Result<Envelope, BusError>
Read a CAN frame.
If no CAN frame is in the RX buffer, this will wait until there is one.
Returns a tuple of the time the message was received and the message frame
sourcepub fn try_read(&mut self) -> Result<Envelope, TryReadError>
pub fn try_read(&mut self) -> Result<Envelope, TryReadError>
Attempts to read a CAN frame without blocking.
Returns [Err(TryReadError::Empty)] if there are no frames in the rx queue.
sourcepub async fn wait_not_empty(&mut self)
pub async fn wait_not_empty(&mut self)
Waits while receive queue is empty.
sourcepub fn buffered<const RX_BUF_SIZE: usize>(
self,
rxb: &'static mut RxBuf<RX_BUF_SIZE>
) -> BufferedCanRx<'d, T, RX_BUF_SIZE>
pub fn buffered<const RX_BUF_SIZE: usize>( self, rxb: &'static mut RxBuf<RX_BUF_SIZE> ) -> BufferedCanRx<'d, T, RX_BUF_SIZE>
Return a buffered instance of driver. User must supply Buffers
Auto Trait Implementations§
impl<'d, T> Freeze for CanRx<'d, T>where
T: Freeze,
impl<'d, T> RefUnwindSafe for CanRx<'d, T>where
T: RefUnwindSafe,
impl<'d, T> Send for CanRx<'d, T>where
T: Send,
impl<'d, T> Sync for CanRx<'d, T>where
T: Sync,
impl<'d, T> Unpin for CanRx<'d, T>where
T: Unpin,
impl<'d, T> !UnwindSafe for CanRx<'d, T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more