Struct serial2::SerialPort

pub struct SerialPort { /* private fields */ }

A serial port.

Implementations

impl SerialPort

pub fn open(name: impl AsRef<Path>, settings: impl IntoSettings) -> Result<Self>

Open and configure a serial port by path or name.

On Unix systems, the name parameter must be a path to a TTY device. On Windows, it must be the name of a COM device, such as COM1, COM2, etc.

The second argument is used to configure the serial port. For simple cases, you pass a u32 for the baud rate. See IntoSettings for more information.

The library automatically uses the win32 device namespace on Windows, so COM ports above COM9 are supported out of the box.

Example

SerialPort::open("/dev/ttyUSB0", 115200)?;

Examples found in repository

examples/serial-cat.rs (line 19)

fn do_main() -> Result<(), ()> {
	let args: Vec<_> = std::env::args().collect();
	if args.len() != 3 {
		let prog_name = args[0].rsplit_once('/').map(|(_parent, name)| name).unwrap_or(&args[0]);
		eprintln!("Usage: {} PORT BAUD", prog_name);
		return Err(());
	}

	let port_name = &args[1];
	let baud_rate: u32 = args[2]
		.parse()
		.map_err(|_| eprintln!("Error: invalid baud rate: {}", args[2]))?;

	let port = SerialPort::open(port_name, baud_rate)
		.map_err(|e| eprintln!("Error: Failed to open {}: {}", port_name, e))?;
	let port = Arc::new(port);

	// Spawn a thread to read from stdin and write to the serial port.
	std::thread::spawn({
		let port = port.clone();
		let port_name = port_name.to_owned();
		move || {
			if let Err(()) = read_stdin_loop(port, &port_name) {
				std::process::exit(1);
			}
		}
	});

	// Read from serial port and write to stdout in main thread.
	read_serial_loop(port, port_name)?;

	Ok(())
}

pub fn available_ports() -> Result<Vec<PathBuf>>

Get a list of available serial ports.

Not currently supported on all platforms. On unsupported platforms, this function always returns an error.

Examples found in repository

examples/list-ports.rs (line 2)

fn main() {
	match serial2::SerialPort::available_ports() {
		Err(e) => {
			eprintln!("Failed to enumerate serial ports: {}", e);
			std::process::exit(1);
		},
		Ok(ports) => {
			eprintln!("Found {} ports", ports.len());
			for port in ports {
				println!("{}", port.display())
			}
		},
	}
}

pub fn set_configuration(&mut self, settings: &Settings) -> Result<()>

Configure (or reconfigure) the serial port.

pub fn get_configuration(&self) -> Result<Settings>

Get the current configuration of the serial port.

This function can fail if the underlying syscall fails, or if the serial port configuration can’t be reported using Settings.

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

Read bytes from the serial port.

This is identical to std::io::Read::read(), except that this function takes a const reference &self. This allows you to use the serial port concurrently from multiple threads.

Note that there are no guarantees on which thread receives what data when multiple threads are reading from the serial port. You should normally limit yourself to a single reading thread and a single writing thread.

Examples found in repository

examples/serial-cat.rs (line 60)

fn read_serial_loop(port: Arc<SerialPort>, port_name: &str) -> Result<(), ()> {
	let mut buffer = [0; 512];
	loop {
		match port.read(&mut buffer) {
			Ok(0) => return Ok(()),
			Ok(n) => {
				std::io::stdout()
					.write_all(&buffer[..n])
					.map_err(|e| eprintln!("Error: Failed to write to stdout: {}", e))?;
			},
			Err(ref e) if e.kind() == std::io::ErrorKind::TimedOut => continue,
			Err(e) => {
				eprintln!("Error: Failed to read from {}: {}", port_name, e);
				return Err(());
			},
		}
	}
}

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

Read bytes from the serial port into a slice of buffers.

This is identical to std::io::Read::read_vectored(), except that this function takes a const reference &self. This allows you to use the serial port concurrently from multiple threads.

Note that there are no guarantees on which thread receives what data when multiple threads are reading from the serial port. You should normally limit yourself to a single reading thread and a single writing thread.

pub fn is_read_vectored(&self) -> bool

Check if the implementation supports vectored reads.

If this returns false, then Self::read_vectored() will only use the first buffer of the given slice. All platforms except for Windows support vectored reads.

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

Write bytes to the serial port.

This is identical to std::io::Write::write(), except that this function takes a const reference &self. This allows you to use the serial port concurrently from multiple threads.

Note that data written to the same serial port from multiple threads may end up interleaved at the receiving side. You should normally limit yourself to a single reading thread and a single writing thread.

Examples found in repository

examples/serial-cat.rs (line 51)

fn read_stdin_loop(port: Arc<SerialPort>, port_name: &str) -> Result<(), ()> {
	let stdin = std::io::stdin();
	let mut stdin = stdin.lock();
	let mut buffer = [0; 512];
	loop {
		let read = stdin
			.read(&mut buffer)
			.map_err(|e| eprintln!("Error: Failed to read from stdin: {}", e))?;
		if read == 0 {
			return Ok(());
		} else {
			port.write(&buffer[..read])
				.map_err(|e| eprintln!("Error: Failed to write to {}: {}", port_name, e))?;
		}
	}
}

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

Write all bytes to the serial port.

This will continue to call Self::write() until the entire buffer has been written, or an I/O error occurs.

This is identical to std::io::Write::write_all(), except that this function takes a const reference &self. This allows you to use the serial port concurrently from multiple threads.

Note that data written to the same serial port from multiple threads may end up interleaved at the receiving side. You should normally limit yourself to a single reading thread and a single writing thread.

pub fn write_vectored(&self, buf: &[IoSlice<'_>]) -> Result<usize>

Write bytes to the serial port from a slice of buffers.

This is identical to std::io::Write::write_vectored(), except that this function takes a const reference &self. This allows you to use the serial port concurrently from multiple threads.

Note that data written to the same serial port from multiple threads may end up interleaved at the receiving side. You should normally limit yourself to a single reading thread and a single writing thread.

pub fn is_write_vectored(&self) -> bool

Check if the implementation supports vectored writes.

If this returns false, then Self::write_vectored() will only use the first buffer of the given slice. All platforms except for Windows support vectored writes.

pub fn flush(&self) -> Result<()>

Flush all data queued to be written.

This will block until the OS buffer has been fully transmitted.

This is identical to std::io::Write::flush(), except that this function takes a const reference &self.

pub fn set_read_timeout(&mut self, timeout: Duration) -> Result<()>

Set the read timeout for the serial port.

The timeout set by this function is an upper bound on individual calls to std::io::Read::read(). Other platform specific time-outs may trigger before this timeout does.

pub fn get_read_timeout(&self) -> Result<Duration>

Get the read timeout of the serial port.

pub fn set_write_timeout(&mut self, timeout: Duration) -> Result<()>

Set the write timeout for the serial port.

The timeout set by this function is an upper bound on individual calls to std::io::Write::write(). Other platform specific time-outs may trigger before this timeout does.

pub fn get_write_timeout(&self) -> Result<Duration>

Get the write timeout of the serial port.

pub fn get_windows_timeouts(&self) -> Result<CommTimeouts>

Available on crate feature windows only.

Get the platform specific timeouts of a serial port on Windows.

This allows for full control over the platform specifics timeouts, but it is only available on Windows.

Also note that changing the read timeouts can easily lead to the serial port timing out on every read unless you are very careful. Please read the whole article about serial port timeouts on MSDN before using this, including all remarks: https://learn.microsoft.com/en-us/windows/win32/api/winbase/ns-winbase-commtimeouts

You are strongly suggested to use Self::get_read_timeout() and Self::get_write_timeout() instead.

pub fn set_windows_timeouts(&self, timeouts: &CommTimeouts) -> Result<()>

Available on crate feature windows only.

Set the platform specific timeouts of a serial port on Windows.

This allows for full control over the platform specifics timeouts, but it is only available on Windows.

Also note that changing the read timeouts can easily lead to the serial port timing out on every read unless you are very careful. Please read the whole article about serial port timeouts on MSDN before using this, including all remarks: https://learn.microsoft.com/en-us/windows/win32/api/winbase/ns-winbase-commtimeouts

You are strongly suggested to use Self::set_read_timeout() and Self::set_write_timeout() instead.

pub fn discard_buffers(&self) -> Result<()>

Discard the kernel input and output buffers for the serial port.

When you write to a serial port, the data may be put in a buffer by the OS to be transmitted by the actual device later. Similarly, data received on the device can be put in a buffer by the OS untill you read it. This function clears both buffers: any untransmitted data and received but unread data is discarded by the OS.

pub fn discard_input_buffer(&self) -> Result<()>

Discard the kernel input buffers for the serial port.

Data received on the device can be put in a buffer by the OS untill you read it. This function clears that buffer: received but unread data is discarded by the OS.

This is particularly useful when communicating with a device that only responds to commands that you send to it. If you discard the input buffer before sending the command, you discard any noise that may have been received after the last command.

pub fn discard_output_buffer(&self) -> Result<()>

Discard the kernel output buffers for the serial port.

When you write to a serial port, the data is generally put in a buffer by the OS to be transmitted by the actual device later. This function clears that buffer: any untransmitted data is discarded by the OS.

pub fn set_rts(&self, state: bool) -> Result<()>

Set the state of the Ready To Send line.

If hardware flow control is enabled on the serial port, it is platform specific what will happen. The function may fail with an error or it may silently be ignored. It may even succeed and interfere with the flow control.

pub fn read_cts(&self) -> Result<bool>

Read the state of the Clear To Send line.

If hardware flow control is enabled on the serial port, it is platform specific what will happen. The function may fail with an error, it may return a bogus value, or it may return the actual state of the CTS line.

pub fn set_dtr(&self, state: bool) -> Result<()>

Set the state of the Data Terminal Ready line.

If hardware flow control is enabled on the serial port, it is platform specific what will happen. The function may fail with an error or it may silently be ignored.

pub fn read_dsr(&self) -> Result<bool>

Read the state of the Data Set Ready line.

If hardware flow control is enabled on the serial port, it is platform specific what will happen. The function may fail with an error, it may return a bogus value, or it may return the actual state of the DSR line.

pub fn read_ri(&self) -> Result<bool>

Read the state of the Ring Indicator line.

This line is also sometimes also called the RNG or RING line.

pub fn read_cd(&self) -> Result<bool>

Read the state of the Carrier Detect (CD) line.

This line is also called the Data Carrier Detect (DCD) line or the Receive Line Signal Detect (RLSD) line.

Trait Implementations

impl AsFd for SerialPort

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for SerialPort

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl From<OwnedFd> for SerialPort

fn from(value: OwnedFd) -> Self

Converts to this type from the input type.

impl From<SerialPort> for OwnedFd

fn from(value: SerialPort) -> Self

Converts to this type from the input type.

impl FromRawFd for SerialPort

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for SerialPort

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for SerialPort

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, buf: &mut [IoSliceMut<'_>]) -> Result<usize>

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>

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

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

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

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

Read 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)

Read 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.

impl Write for SerialPort

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

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, buf: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.