Trait Uart

pub trait Uart {
    // Required methods
    fn get_baudrate(&self) -> Result<u32>;
    fn set_baudrate(&self, baudrate: u32) -> Result<()>;
    fn read(&self, buf: &mut [u8]) -> Result<usize>;
    fn read_timeout(&self, buf: &mut [u8], timeout: Duration) -> 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 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> { ... }
    fn supports_nonblocking_read(&self) -> Result<bool> { ... }
    fn register_nonblocking_read(
        &self,
        _registry: &Registry,
        _token: Token,
    ) -> Result<()> { ... }
    fn nonblocking_help(&self) -> Result<Rc<dyn NonblockingHelp>> { ... }
}

A trait which represents a UART.

Required Methods

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

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

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

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

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

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

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 write(&self, buf: &[u8]) -> Result<()>

Writes data from buf to the UART.

Provided Methods

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 clear_rx_buffer(&self) -> Result<()>

Clears the UART RX buffer.

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

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

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

fn supports_nonblocking_read(&self) -> Result<bool>

Query if nonblocking mio mode is supported.

fn register_nonblocking_read( &self, _registry: &Registry, _token: Token, ) -> Result<()>

Switch this Uart instance into nonblocking mio mode. Going forward, read() should only be called after mio::poll() has indicated that the given Token is ready.

fn nonblocking_help(&self) -> Result<Rc<dyn NonblockingHelp>>

Get the same single NonblockingHelp object as from top level Transport.nonblocking_help().

Trait Implementations

impl<'a> ConsoleDevice for dyn Uart + 'a

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

Reads data from the UART to print to the console (used when this UART is the console device).

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

Writes console input data to the UART (used when this UART is the console device).

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

fn supports_nonblocking_read(&self) -> Result<bool>

Query if nonblocking mio mode is supported.

fn register_nonblocking_read( &self, registry: &Registry, token: Token, ) -> Result<()>

Switch this Uart instance into nonblocking mio mode. Going forward, read() should only be called after mio::poll() has indicated that the given Token is ready.

fn nonblocking_help(&self) -> Result<Rc<dyn NonblockingHelp>>

Get the same single NonblockingHelp object as from top level Transport.nonblocking_help().

fn get_tx_ready_pin(&self) -> Result<Option<&Rc<dyn GpioPin>>>

Query if TX-ready pin non-polling mode is supported.

impl Read for &dyn Uart

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

Implementors

impl Uart for SerialPortUart

impl Uart for HyperdebugUart

impl Uart for ChildUart