Struct stm32_hal2::serial::Rx

pub struct Rx<USART> { /* fields omitted */ }

Serial receiver

Implementations

impl Rx<USART1>

pub fn circ_read<B, H>(&self, chan: C5, buffer: B) -> CircBuffer<B, C5> where
    B: StableDeref<Target = [H; 2]> + DerefMut + 'static,
    H: AsMutSlice<Element = u8>, 

pub fn frame_read<BUFFER, N>(
    &self,
    channel: C5,
    buffer: BUFFER
) -> FrameReader<BUFFER, C5, N> where
    BUFFER: Sized + StableDeref<Target = DMAFrame<N>> + DerefMut + 'static,
    N: ArrayLength<MaybeUninit<u8>>, 

Create a frame reader that can either react on the Character match interrupt or Transfer Complete from the DMA.

pub fn is_idle(&mut self, clear: bool) -> bool

Checks to see if the USART peripheral has detected an idle line and clears the flag

pub fn is_character_match(&mut self, clear: bool) -> bool

Checks to see if the USART peripheral has detected an character match and clears the flag

pub fn is_receiver_timeout(&mut self, clear: bool) -> bool

Checks to see if the USART peripheral has detected an receiver timeout and clears the flag

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

Check for, and return, any errors

The read methods can only return one error at a time, but there might actually be multiple errors. This method will return and clear a currently active error. Once it returns Ok(()), it should be possible to proceed with the next read call unimpeded.

impl Rx<USART2>

pub fn circ_read<B, H>(&self, chan: C6, buffer: B) -> CircBuffer<B, C6> where
    B: StableDeref<Target = [H; 2]> + DerefMut + 'static,
    H: AsMutSlice<Element = u8>, 

pub fn frame_read<BUFFER, N>(
    &self,
    channel: C6,
    buffer: BUFFER
) -> FrameReader<BUFFER, C6, N> where
    BUFFER: Sized + StableDeref<Target = DMAFrame<N>> + DerefMut + 'static,
    N: ArrayLength<MaybeUninit<u8>>, 

Create a frame reader that can either react on the Character match interrupt or Transfer Complete from the DMA.

pub fn is_idle(&mut self, clear: bool) -> bool

Checks to see if the USART peripheral has detected an idle line and clears the flag

pub fn is_character_match(&mut self, clear: bool) -> bool

Checks to see if the USART peripheral has detected an character match and clears the flag

pub fn is_receiver_timeout(&mut self, clear: bool) -> bool

Checks to see if the USART peripheral has detected an receiver timeout and clears the flag

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

Check for, and return, any errors

The read methods can only return one error at a time, but there might actually be multiple errors. This method will return and clear a currently active error. Once it returns Ok(()), it should be possible to proceed with the next read call unimpeded.

Trait Implementations

impl Read<u8> for Rx<USART1>

type Error = Error

Read error

fn read(&mut self) -> Result<u8, Error>

Reads a single word from the serial interface

impl Read<u8> for Rx<USART2>

type Error = Error

Read error

fn read(&mut self) -> Result<u8, Error>

Reads a single word from the serial interface