Struct stm32f072b_disco::serial::Serial

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

Serial abstraction

Methods

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

pub fn split(self) -> (Tx<USART>, Rx<USART>) where
    RXPIN: RxPin<USART>,
    TXPIN: TxPin<USART>, 

Splits the UART Peripheral in a Tx and an Rx part This is required for sending/receiving

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

impl<TXPIN, RXPIN> Serial<USART1, TXPIN, RXPIN> where
    RXPIN: RxPin<USART1>,
    TXPIN: TxPin<USART1>, 

pub fn usart1(
    usart: USART1,
    pins: (TXPIN, RXPIN),
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART1, TXPIN, RXPIN>

Creates a new serial instance

impl<TXPIN> Serial<USART1, TXPIN, ()> where
    TXPIN: TxPin<USART1>, 

pub fn usart1tx(
    usart: USART1,
    txpin: TXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART1, TXPIN, ()>

Creates a new tx-only serial instance

impl<RXPIN> Serial<USART1, (), RXPIN> where
    RXPIN: RxPin<USART1>, 

pub fn usart1rx(
    usart: USART1,
    rxpin: RXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART1, (), RXPIN>

Creates a new tx-only serial instance

impl<TXPIN, RXPIN> Serial<USART1, TXPIN, RXPIN>

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

Starts listening for an interrupt event

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

Stop listening for an interrupt event

impl<TXPIN, RXPIN> Serial<USART2, TXPIN, RXPIN> where
    RXPIN: RxPin<USART2>,
    TXPIN: TxPin<USART2>, 

pub fn usart2(
    usart: USART2,
    pins: (TXPIN, RXPIN),
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART2, TXPIN, RXPIN>

Creates a new serial instance

impl<TXPIN> Serial<USART2, TXPIN, ()> where
    TXPIN: TxPin<USART2>, 

pub fn usart2tx(
    usart: USART2,
    txpin: TXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART2, TXPIN, ()>

Creates a new tx-only serial instance

impl<RXPIN> Serial<USART2, (), RXPIN> where
    RXPIN: RxPin<USART2>, 

pub fn usart2rx(
    usart: USART2,
    rxpin: RXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART2, (), RXPIN>

Creates a new tx-only serial instance

impl<TXPIN, RXPIN> Serial<USART2, TXPIN, RXPIN>

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

Starts listening for an interrupt event

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

Stop listening for an interrupt event

impl<TXPIN, RXPIN> Serial<USART3, TXPIN, RXPIN> where
    RXPIN: RxPin<USART3>,
    TXPIN: TxPin<USART3>, 

pub fn usart3(
    usart: USART3,
    pins: (TXPIN, RXPIN),
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART3, TXPIN, RXPIN>

Creates a new serial instance

impl<TXPIN> Serial<USART3, TXPIN, ()> where
    TXPIN: TxPin<USART3>, 

pub fn usart3tx(
    usart: USART3,
    txpin: TXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART3, TXPIN, ()>

Creates a new tx-only serial instance

impl<RXPIN> Serial<USART3, (), RXPIN> where
    RXPIN: RxPin<USART3>, 

pub fn usart3rx(
    usart: USART3,
    rxpin: RXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART3, (), RXPIN>

Creates a new tx-only serial instance

impl<TXPIN, RXPIN> Serial<USART3, TXPIN, RXPIN>

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

Starts listening for an interrupt event

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

Stop listening for an interrupt event

impl<TXPIN, RXPIN> Serial<USART4, TXPIN, RXPIN> where
    RXPIN: RxPin<USART4>,
    TXPIN: TxPin<USART4>, 

pub fn usart4(
    usart: USART4,
    pins: (TXPIN, RXPIN),
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART4, TXPIN, RXPIN>

Creates a new serial instance

impl<TXPIN> Serial<USART4, TXPIN, ()> where
    TXPIN: TxPin<USART4>, 

pub fn usart4tx(
    usart: USART4,
    txpin: TXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART4, TXPIN, ()>

Creates a new tx-only serial instance

impl<RXPIN> Serial<USART4, (), RXPIN> where
    RXPIN: RxPin<USART4>, 

pub fn usart4rx(
    usart: USART4,
    rxpin: RXPIN,
    baud_rate: Bps,
    rcc: &mut Rcc
) -> Serial<USART4, (), RXPIN>

Creates a new tx-only serial instance

impl<TXPIN, RXPIN> Serial<USART4, TXPIN, RXPIN>

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

Starts listening for an interrupt event

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

Stop listening for an interrupt event

Trait Implementations

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

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

Writes a slice of bytes 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, TXPIN, RXPIN> Read<u8> for Serial<USART, TXPIN, RXPIN> where
    RXPIN: RxPin<USART>,
    USART: Deref<Target = RegisterBlock>, 

type Error = Error

Read error

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

Tries to read a byte from the uart

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

type Error = Void

Write error

fn flush(
    &mut self
) -> Result<(), Error<<Serial<USART, TXPIN, RXPIN> as Write<u8>>::Error>>

Ensures that none of the previously written words are still buffered

fn write(
    &mut self,
    byte: u8
) -> Result<(), Error<<Serial<USART, TXPIN, RXPIN> as Write<u8>>::Error>>

Tries to write a byte to the uart Fails if the transmit buffer is full