Skip to main content

SerialIO

Trait SerialIO 

Source
pub trait SerialIO {
    type Error;

    // Required methods
    fn write(&mut self, data: &[u8]) -> Result<usize, Self::Error>;
    fn read(&mut self, buffer: &mut [u8]) -> Result<usize, Self::Error>;
    fn flush(&mut self) -> Result<(), Self::Error>;

    // Provided method
    fn available(&self) -> Result<bool, Self::Error> { ... }
}
Expand description

Serial I/O abstraction for embedded platforms

Required Associated Types§

Source

type Error

Platform-specific error type

Required Methods§

Source

fn write(&mut self, data: &[u8]) -> Result<usize, Self::Error>

Write bytes to serial port

§Arguments
  • data - Bytes to write
§Returns

Number of bytes written or error

Source

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

Read bytes from serial port (non-blocking)

§Arguments
  • buffer - Buffer to read into
§Returns

Number of bytes read or error

Source

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

Flush output buffer

§Returns

Ok(()) or error

Provided Methods§

Source

fn available(&self) -> Result<bool, Self::Error>

Check if data is available to read

§Returns

True if data is available

Implementors§