Struct CanFdRx 

pub struct CanFdRx<'a, Dm: DriverMode> { /* private fields */ }

Receiving half of a split controller.

Borrows the driver, which keeps the configuration and the teardown. See CanFd::split.

Implementations

impl<Dm: DriverMode> CanFdRx<'_, Dm>

pub fn rx_frame_count(&self) -> u16

Returns the number of complete frames waiting in the RX buffer.

pub fn receive(&mut self) -> Result<Frame, Error>

Reads one frame from the RX buffer.

Errors

Error::RxBufferEmpty when no complete frame is waiting.

pub fn flush_rx(&mut self)

Discards everything in the RX buffer.

pub fn rx_buffer_size_words(&self) -> u16

Returns the size of the RX buffer in 32-bit words.

pub fn rx_buffer_free_words(&self) -> u16

Returns the free space in the RX buffer in 32-bit words.

pub fn rx_overrun(&self) -> bool

Returns whether the RX buffer has overrun and dropped a frame (TRM 38.3.9.4).

pub fn clear_rx_overrun(&mut self)

Clears the RX buffer overrun flag.

pub fn error_state(&self) -> ErrorState

Returns the current fault confinement state; see CanFd::error_state.

pub fn receive_error_count(&self) -> u16

Returns the receive error counter.

pub fn transmit_error_count(&self) -> u16

Returns the transmit error counter.

impl CanFdRx<'_, Async>

pub async fn receive_async(&mut self) -> Frame

Waits until a frame is received, then reads it.

Cancellation Safety

This future is cancel-safe. A frame stays in the hardware RX buffer until it is read, so dropping the future loses nothing.

Trait Implementations

impl<Dm: DriverMode> Debug for CanFdRx<'_, Dm>

Available on crate feature unstable only.

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

Formats the value using the given formatter.