Struct stm32l0xx_hal::serial::Rx

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

Serial receiver

Implementations

impl Rx<LPUART1>

pub fn is_idle(&self) -> bool

Returns true if the line idle status is set This reads the ISR register’s IDLE bit. This bit is set by hardware when an Idle Line is detected. And can be cleared by calling clear_idle_interrupt.

This flag is set by hardware even when interrupts are disabled (IDLEIE=0 in CR1)

pub fn is_rx_not_empty(&self) -> bool

Returns true if the rx register is not empty (and can be read)

pub fn clear_idle_interrupt(&self)

Clear idle line interrupt flag

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

Checks for reception errors that may have occurred.

Note that multiple errors can be signaled at the same time. In that case, calling this function repeatedly will return the remaining errors.

pub fn clear_errors(&mut self)

Clears any signaled errors without returning them.

impl Rx<LPUART1>

DMA operations.

pub fn read_all<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

pub fn read_some<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    num_words: usize,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

impl Rx<USART2>

pub fn is_idle(&self) -> bool

Returns true if the line idle status is set This reads the ISR register’s IDLE bit. This bit is set by hardware when an Idle Line is detected. And can be cleared by calling clear_idle_interrupt.

This flag is set by hardware even when interrupts are disabled (IDLEIE=0 in CR1)

pub fn is_rx_not_empty(&self) -> bool

Returns true if the rx register is not empty (and can be read)

pub fn clear_idle_interrupt(&self)

Clear idle line interrupt flag

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

Checks for reception errors that may have occurred.

Note that multiple errors can be signaled at the same time. In that case, calling this function repeatedly will return the remaining errors.

pub fn clear_errors(&mut self)

Clears any signaled errors without returning them.

impl Rx<USART2>

DMA operations.

pub fn read_all<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

pub fn read_some<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    num_words: usize,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

impl Rx<USART1>

pub fn is_idle(&self) -> bool

Returns true if the line idle status is set This reads the ISR register’s IDLE bit. This bit is set by hardware when an Idle Line is detected. And can be cleared by calling clear_idle_interrupt.

This flag is set by hardware even when interrupts are disabled (IDLEIE=0 in CR1)

pub fn is_rx_not_empty(&self) -> bool

Returns true if the rx register is not empty (and can be read)

pub fn clear_idle_interrupt(&self)

Clear idle line interrupt flag

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

Checks for reception errors that may have occurred.

Note that multiple errors can be signaled at the same time. In that case, calling this function repeatedly will return the remaining errors.

pub fn clear_errors(&mut self)

Clears any signaled errors without returning them.

impl Rx<USART1>

DMA operations.

pub fn read_all<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

pub fn read_some<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    num_words: usize,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

impl Rx<USART4>

pub fn is_idle(&self) -> bool

Returns true if the line idle status is set This reads the ISR register’s IDLE bit. This bit is set by hardware when an Idle Line is detected. And can be cleared by calling clear_idle_interrupt.

This flag is set by hardware even when interrupts are disabled (IDLEIE=0 in CR1)

pub fn is_rx_not_empty(&self) -> bool

Returns true if the rx register is not empty (and can be read)

pub fn clear_idle_interrupt(&self)

Clear idle line interrupt flag

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

Checks for reception errors that may have occurred.

Note that multiple errors can be signaled at the same time. In that case, calling this function repeatedly will return the remaining errors.

pub fn clear_errors(&mut self)

Clears any signaled errors without returning them.

impl Rx<USART4>

DMA operations.

pub fn read_all<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

pub fn read_some<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    num_words: usize,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

impl Rx<USART5>

pub fn is_idle(&self) -> bool

Returns true if the line idle status is set This reads the ISR register’s IDLE bit. This bit is set by hardware when an Idle Line is detected. And can be cleared by calling clear_idle_interrupt.

This flag is set by hardware even when interrupts are disabled (IDLEIE=0 in CR1)

pub fn is_rx_not_empty(&self) -> bool

Returns true if the rx register is not empty (and can be read)

pub fn clear_idle_interrupt(&self)

Clear idle line interrupt flag

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

Checks for reception errors that may have occurred.

Note that multiple errors can be signaled at the same time. In that case, calling this function repeatedly will return the remaining errors.

pub fn clear_errors(&mut self)

Clears any signaled errors without returning them.

impl Rx<USART5>

DMA operations.

pub fn read_all<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

pub fn read_some<Buffer, Channel>(
    self,
    dma: &mut Handle,
    buffer: Pin<Buffer>,
    num_words: usize,
    channel: Channel
) -> Transfer<Self, Channel, Buffer, Ready> where
    Self: Target<Channel>,
    Buffer: DerefMut + 'static,
    Buffer::Target: AsMutSlice<Element = u8>,
    Channel: Channel, 

Trait Implementations

impl Read<u8> for Rx<LPUART1>

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<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

impl Read<u8> for Rx<USART4>

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<USART5>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl Target<Channel3> for Rx<USART1>

const REQUEST: u8 = 3u8

impl Target<Channel5> for Rx<USART1>

const REQUEST: u8 = 3u8

impl Target<Channel5> for Rx<USART2>

const REQUEST: u8 = 4u8

impl Target<Channel6> for Rx<USART2>

const REQUEST: u8 = 4u8