Struct SyncSerialPort

pub struct SyncSerialPort { /* private fields */ }

A serial port that you can interact with synchronously.

Implementations

impl SyncSerialPort

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

Get a list of available serial ports.

Errors

• If the platform is not supported.
• If we get an error from the OS listing ports.

pub fn new(name: impl AsRef<Path>) -> IoResult<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 library automatically uses the win32 device namespace on Windows, so COM ports above COM9 are supported out of the box.

Errors

If we cannot open the

pub fn try_clone(&self) -> IoResult<Self>

Try to clone the serial port handle.

The cloned object refers to the same serial port.

Mixing reads and writes on different handles to the same serial port from different threads may lead to unexpect results. The data may end up interleaved in unpredictable ways.

Errors

If we cannot clone the underlying file descriptor/handle.

pub fn read(&self, buff: &mut [u8]) -> IoResult<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.

Errors

If we get an error back from the OS.

pub fn read_exact(&self, buff: &mut [u8]) -> IoResult<()>

Read the exact number of bytes required to fill the buffer from the serial port.

This will repeatedly call read() until the entire buffer is filled. Errors of the type std::io::ErrorKind::Interrupted are silently ignored. Any other errors (including timeouts) will be returned immediately.

If this function returns an error, it may already have read some data from the serial port into the provided buffer.

This function is identical to std::io::Read::read_exact(), 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.

Errors

If we get an error back from the OS.

pub const fn can_read_vectored() -> bool

If this implementation supports vectored reads.

pub fn read_vectored(&self, buff: &mut [IoSliceMut<'_>]) -> IoResult<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.

Errors

If we get an error back from the OS.

pub fn write(&self, buff: &[u8]) -> IoResult<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.

Errors

If we get an error back from the OS.

pub fn write_all(&self, buff: &[u8]) -> IoResult<()>

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.

Errors

If we get an error back from the OS.

pub const fn can_write_vectored() -> bool

If this implementation supports vectored writes.

pub fn write_vectored(&self, buff: &[IoSlice<'_>]) -> IoResult<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.

Errors

If we get an error back from the OS.

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

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.

Errors

If we get an error back from the OS.

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

Get the read timeout for the serial port.

The timeout gotten 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.

Errors

If we get an error back from the OS.

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

Get the write timeout for the serial port.

The timeout gotten 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.

Errors

If we get an error back from the OS.

pub fn set_read_timeout(&mut self, new_timeout: Duration) -> IoResult<()>

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.

Errors

If we get an error back from the OS.

pub fn set_write_timeout(&mut self, new_timeout: Duration) -> IoResult<()>

Set the read 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.

Errors

If we get an error back from the OS.

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

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.

Errors

If we get an error back from the OS.

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

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.

Errors

If we get an error back from the OS.

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

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.

Errors

If we get an error back from the OS.

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

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.

Errors

If we get an error back from the OS.

pub fn read_cts(&self) -> IoResult<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.

Errors

If we get an error back from the OS.

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

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.

Errors

If we get an error back from the OS.

pub fn read_dsr(&self) -> IoResult<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.

Errors

If we get an error back from the OS.

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

Read the state of the Ring Indicator line.

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

Errors

If we get an error back from the OS.

pub fn read_cd(&self) -> IoResult<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.

Errors

If we get an error back from the OS.

Trait Implementations

impl AsFd for SyncSerialPort

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

Borrows the file descriptor.

impl AsRawFd for SyncSerialPort

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for SyncSerialPort

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<OwnedFd> for SyncSerialPort

fn from(value: OwnedFd) -> Self

Converts to this type from the input type.

impl From<SyncSerialPort> for OwnedFd

fn from(value: SyncSerialPort) -> Self

Converts to this type from the input type.

impl FromRawFd for SyncSerialPort

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for SyncSerialPort

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for &SyncSerialPort

fn read(&mut self, buff: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> IoResult<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>

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

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

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

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

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

Reads 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 Read for SyncSerialPort

fn read(&mut self, buff: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> IoResult<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>

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

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

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

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

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

Reads 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 &SyncSerialPort

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

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

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

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

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

Flushes 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, args: 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.

impl Write for SyncSerialPort

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

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

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

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

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

Flushes 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, args: 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.