Crate serialport[][src]

serialport-rs is a cross-platform serial port library.

The goal of this library is to expose a cross-platform and platform-specific API for enumerating and using blocking I/O with serial ports. This library exposes a similar API to that provided by Qt's QSerialPort library.

Feature Overview

The library has been organized such that there is a high-level SerialPort trait that provides a cross-platform API for accessing serial ports. This is the preferred method of interacting with ports and as such is part of the prelude. The open*() and available_ports() functions in the root provide cross-platform functionality.

For platform-specific functionaly, this crate is split into a posix and windows API with corresponding TTYPort and COMPort structs (that both implement the SerialPort trait). Using the platform-specific open*() functions will return the platform-specific port object which allows access to platform-specific functionality.

Modules

posix

The implementation of serialport for POSIX-based systems (Linux, BSD, Mac)

prelude

A module that exports types that are useful to have in scope.

Structs

Error

An error type for serial port operations.

SerialPortInfo

A device-independent implementation of serial port information.

SerialPortSettings

A struct containing all serial port settings

UsbPortInfo

Contains all possible USB information about a SerialPort

Enums

DataBits

Number of bits per character.

ErrorKind

Categories of errors that can occur when interacting with serial ports.

FlowControl

Flow control modes.

Parity

Parity checking modes.

SerialPortType

The physical type of a SerialPort

StopBits

Number of stop bits.

Traits

SerialPort

A trait for serial port devices

Functions

available_ports

Returns a list of all serial ports on system

open

Opens the serial port specified by the device path using default settings.

open_with_settings

Opens the serial port specified by the device path with the given settings.

Type Definitions

Result

A type for results generated by interacting with serial ports.