Struct SerialPort 

pub struct SerialPort<R: Runtime>(pub PluginHandle<R>);

Access to the serial port APIs for mobile platforms.

Tuple Fields

0: PluginHandle<R>

Implementations

impl<R: Runtime> SerialPort<R>

pub fn available_ports( &self, ) -> Result<HashMap<String, HashMap<String, String>>, Error>

Lists all available serial ports

pub fn available_ports_direct( &self, ) -> Result<HashMap<String, HashMap<String, String>>, Error>

Lists all available serial ports using direct system commands

pub fn managed_ports(&self) -> Result<Vec<String>, Error>

Lists all managed serial ports (ports that are currently open and managed by the application).

pub fn open( &self, path: String, baud_rate: u32, data_bits: Option<DataBits>, flow_control: Option<FlowControl>, parity: Option<Parity>, stop_bits: Option<StopBits>, timeout: Option<u64>, ) -> Result<(), Error>

Opens a serial port with the specified settings

pub fn close(&self, path: String) -> Result<(), Error>

Closes a serial port

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

Closes all open serial ports

pub fn force_close(&self, path: String) -> Result<(), Error>

Force closes a serial port

pub fn write(&self, path: String, data: String) -> Result<usize, Error>

Writes data to the serial port

pub fn write_binary(&self, path: String, data: Vec<u8>) -> Result<usize, Error>

Writes binary data to the serial port

pub fn read( &self, path: String, timeout: Option<u64>, size: Option<usize>, ) -> Result<String, Error>

Reads data from the serial port

pub fn read_binary( &self, path: String, timeout: Option<u64>, size: Option<usize>, ) -> Result<Vec<u8>, Error>

Reads data from the serial port

pub fn start_listening( &self, path: String, timeout: Option<u64>, size: Option<usize>, ) -> Result<(), Error>

Starts listening for data on the serial port

pub fn stop_listening(&self, path: String) -> Result<(), Error>

Stops listening for data on the serial port

pub fn set_baud_rate(&self, path: String, baud_rate: u32) -> Result<(), Error>

Sets the baud rate for the serial port

pub fn set_data_bits( &self, path: String, data_bits: DataBits, ) -> Result<(), Error>

Sets the data bits for the serial port

pub fn set_flow_control( &self, path: String, flow_control: FlowControl, ) -> Result<(), Error>

Sets the flow control for the serial port

pub fn set_parity(&self, path: String, parity: Parity) -> Result<(), Error>

Sets the parity for the serial port

pub fn set_stop_bits( &self, path: String, stop_bits: StopBits, ) -> Result<(), Error>

Sets the stop bits for the serial port

pub fn set_timeout(&self, path: String, timeout: Duration) -> Result<(), Error>

Sets the timeout for the serial port

pub fn write_request_to_send( &self, path: String, level: bool, ) -> Result<(), Error>

Sets the RTS (Request To Send) signal

pub fn write_data_terminal_ready( &self, path: String, level: bool, ) -> Result<(), Error>

Sets the DTR (Data Terminal Ready) signal

pub fn cancel_read(&self, path: String) -> Result<(), Error>

pub fn read_clear_to_send(&self, path: String) -> Result<bool, Error>

Reads the CTS (Clear To Send) signal state

pub fn read_data_set_ready(&self, path: String) -> Result<bool, Error>

Reads the DSR (Data Set Ready) signal state

pub fn read_ring_indicator(&self, path: String) -> Result<bool, Error>

Reads the RI (Ring Indicator) signal state

pub fn read_carrier_detect(&self, path: String) -> Result<bool, Error>

Reads the CD (Carrier Detect) signal state

pub fn bytes_to_read(&self, path: String) -> Result<u32, Error>

Gets the number of bytes available to read

pub fn bytes_to_write(&self, path: String) -> Result<u32, Error>

Gets the number of bytes waiting to be written

pub fn clear_buffer( &self, path: String, buffer_type: ClearBuffer, ) -> Result<(), Error>

Clears the specified buffer

pub fn set_break(&self, path: String) -> Result<(), Error>

Sets the break signal

pub fn clear_break(&self, path: String) -> Result<(), Error>

Clears the break signal