Struct gd32f1x0_hal::serial::Serial

pub struct Serial<USART, TXPIN, RXPIN> { /* private fields */ }

Serial abstraction

Implementations

impl<USART: RcuBus + Enable + Reset + Deref<Target = RegisterBlock>, TXPIN: TxPin<USART>, RXPIN: RxPin<USART>> Serial<USART, TXPIN, RXPIN> where
    USART::Bus: GetBusFreq, 

pub fn usart(
    usart: USART,
    pins: (TXPIN, RXPIN),
    config: Config,
    clocks: Clocks,
    bus: &mut USART::Bus
) -> Self

Configures the USART and creates a new Serial instance.

pub fn split(self) -> (Tx<USART>, Rx<USART>)

Separates the serial struct into separate channel objects for sending (Tx) and receiving (Rx).

impl<USART: RcuBus + Enable + Reset + Deref<Target = RegisterBlock>, TXPIN: TxPin<USART>> Serial<USART, TXPIN, ()> where
    USART::Bus: GetBusFreq, 

pub fn usart_tx(
    usart: USART,
    txpin: TXPIN,
    config: Config,
    clocks: Clocks,
    bus: &mut USART::Bus
) -> Self

Configures the USART and creates a new TX-only Serial instance.

pub fn downgrade_tx(self) -> Tx<USART>

Erase the pin.

impl<USART: RcuBus + Enable + Reset + Deref<Target = RegisterBlock>, RXPIN: RxPin<USART>> Serial<USART, (), RXPIN> where
    USART::Bus: GetBusFreq, 

pub fn usart_rx(
    usart: USART,
    rxpin: RXPIN,
    config: Config,
    clocks: Clocks,
    bus: &mut USART::Bus
) -> Self

Configures the USART and creates a new RX-only Serial instance.

pub fn downgrade_rx(self) -> Rx<USART>

Erase the pin.

impl<USART: Deref<Target = RegisterBlock>, TXPIN, RXPIN> Serial<USART, TXPIN, RXPIN>

pub fn release(self) -> (USART, (TXPIN, RXPIN))

pub fn listen(&mut self, event: Event)

Enable an interrupt event.

pub fn unlisten(&mut self, event: Event)

Disable an interrupt event.

Trait Implementations

impl<USART: Deref<Target = RegisterBlock>, TXPIN, RXPIN: RxPin<USART>> Read<u8> for Serial<USART, TXPIN, RXPIN>

type Error = Error

Read error

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

Reads a single word from the serial interface

impl<USART: Deref<Target = RegisterBlock>, TXPIN: TxPin<USART>, RXPIN> Write for Serial<USART, TXPIN, RXPIN>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl<USART: Deref<Target = RegisterBlock>, TXPIN: TxPin<USART>, RXPIN> Write<u8> for Serial<USART, TXPIN, RXPIN>

type Error = Infallible

Write error

fn flush(&mut self) -> Result<(), Self::Error>

Ensures that none of the previously written words are still buffered

fn write(&mut self, byte: u8) -> Result<(), Self::Error>

Writes a single word to the serial interface