Trait Uart

Source

pub trait Uart {
Show 13 methods    // Required methods
    fn get_baudrate(&self) -> Result<u32>;
    fn set_baudrate(&self, baudrate: u32) -> Result<()>;
    fn poll_read(
        &self,
        cx: &mut Context<'_>,
        buf: &mut [u8],
    ) -> Poll<Result<usize>>;
    fn write(&self, buf: &[u8]) -> Result<()>;

    // Provided methods
    fn get_flow_control(&self) -> Result<FlowControl> { ... }
    fn set_flow_control(&self, flow_control: bool) -> Result<()> { ... }
    fn get_device_path(&self) -> Result<String> { ... }
    fn read(&self, buf: &mut [u8]) -> Result<usize> { ... }
    fn read_timeout(&self, buf: &mut [u8], timeout: Duration) -> Result<usize> { ... }
    fn clear_rx_buffer(&self) -> Result<()> { ... }
    fn set_break(&self, _enable: bool) -> Result<()> { ... }
    fn set_parity(&self, _parity: Parity) -> Result<()> { ... }
    fn get_parity(&self) -> Result<Parity> { ... }
}

Expand description

A trait which represents a UART.

Required Methods§

Source

fn get_baudrate(&self) -> Result<u32>

Returns the UART baudrate. May return zero for virtual UARTs.

Source

fn set_baudrate(&self, baudrate: u32) -> Result<()>

Sets the UART baudrate. May do nothing for virtual UARTs.

Source

fn poll_read(&self, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<Result<usize>>

Reads UART receive data into buf, returning the number of bytes read.

If data is not yet ready, Poll::Pending will be returned and cx would be notified when it’s available. When this function is called with multiple wakers, all wakers should be notified instead of just the last one.

Source

fn write(&self, buf: &[u8]) -> Result<()>

Writes data from buf to the UART.

Provided Methods§

Source

fn get_flow_control(&self) -> Result<FlowControl>

Source

fn set_flow_control(&self, flow_control: bool) -> Result<()>

Enables software flow control for writes.

Source

fn get_device_path(&self) -> Result<String>

Returns "/dev/ttyUSBn" or similar OS device path usable by external programs for directly accessing the serial port.

Source

fn read(&self, buf: &mut [u8]) -> Result<usize>

Reads UART receive data into buf, returning the number of bytes read. This function is blocking.

Source

fn read_timeout(&self, buf: &mut [u8], timeout: Duration) -> Result<usize>

Reads UART receive data into buf, returning the number of bytes read. The timeout may be used to specify a duration to wait for data. If timeout expires without any data arriving Ok(0) will be returned, never Err(_).

Source