Struct SoftwareFlowControl

pub struct SoftwareFlowControl<T> { /* private fields */ }

Add software flow control to a UART device.

Flow control is performed using XON/XOFF bytes.

Implementations

impl<T: Uart> SoftwareFlowControl<T>

pub fn new(inner: T) -> Self

Open the given serial device, such as /dev/ttyUSB0.

Trait Implementations

impl<T: Uart> Uart for SoftwareFlowControl<T>

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

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

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

Writes data from buf to the UART.

fn clear_rx_buffer(&self) -> Result<()>

Clears the UART RX buffer.

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

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

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

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

Enables software flow control for writes.

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.

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.

fn set_break(&self, enable: bool) -> Result<()>

fn set_parity(&self, parity: Parity) -> Result<()>

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

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

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(_).

fn get_parity(&self) -> Result<Parity>