Struct Serial 

pub struct Serial(/* private fields */);

Represents the generic serial interface of a smart port.

Implementations

impl Serial

pub unsafe fn new(port: u8, baudrate: i32) -> Result<Self, Error>

Constructs a new generic serial port.

Safety

This function is unsafe because it allows the user to create multiple mutable references to the same smart port interface. You likely want to implement Robot::new() instead.

pub fn set_baudrate(&mut self, baudrate: i32) -> Result<(), Error>

Changes the baudrate of the serial port.

pub fn get_read_avail(&self) -> Result<usize, Error>

Gets the number of bytes available to read in the input buffer of the serial port.

pub fn get_write_free(&self) -> Result<usize, Error>

Gets the number of bytes free in the output buffer of the serial port.

pub fn peek_byte(&self) -> Result<u8, Error>

Reads the next available byte in the input buffer of the serial port without removing it.

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

Reads the next available byte in the input buffer of the serial port.

pub fn write_byte(&mut self, byte: u8) -> Result<(), Error>

Writes the given byte to the output buffer of the serial port.

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

Reads as many bytes as possible from the input buffer of the serial port into the given buffer, returning the number read.

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

Writes as many bytes as possible to the output buffer of the serial port from the given buffer, returning the number written.

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

Clears the internal input and output buffers of the serial port, effectively resetting its state.

Trait Implementations

impl TryFrom<(SmartPort, i32)> for Serial

type Error = Error

The type returned in the event of a conversion error.

fn try_from((port, baudrate): (SmartPort, i32)) -> Result<Self, Self::Error>

Performs the conversion.