Struct serial2::SerialPort
source · [−]pub struct SerialPort { /* private fields */ }
Expand description
A serial port.
Implementations
sourceimpl SerialPort
impl SerialPort
sourcepub fn open(name: impl AsRef<Path>, settings: impl IntoSettings) -> Result<Self>
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.
Example
SerialPort::open("/dev/ttyUSB0", 115200)?;
sourcepub fn available_ports() -> Result<Vec<PathBuf>>
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.
sourcepub fn set_configuration(&mut self, settings: &Settings) -> Result<()>
pub fn set_configuration(&mut self, settings: &Settings) -> Result<()>
Configure (or reconfigure) the serial port.
sourcepub fn get_configuration(&self) -> Result<Settings>
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
.
sourcepub fn read(&self, buf: &mut [u8]) -> Result<usize>
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.
sourcepub fn read_vectored(&self, buf: &mut [IoSliceMut<'_>]) -> Result<usize>
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.
sourcepub fn is_read_vectored(&self) -> bool
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.
sourcepub fn write(&self, buf: &[u8]) -> Result<usize>
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.
sourcepub fn write_all(&self, buf: &[u8]) -> Result<()>
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.
sourcepub fn write_vectored(&self, buf: &[IoSlice<'_>]) -> Result<usize>
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.
sourcepub fn is_write_vectored(&self) -> bool
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.
sourcepub fn flush(&self) -> Result<()>
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
.
sourcepub fn set_read_timeout(&mut self, timeout: Duration) -> Result<()>
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.
sourcepub fn get_read_timeout(&self) -> Result<Duration>
pub fn get_read_timeout(&self) -> Result<Duration>
Get the read timeout of the serial port.
sourcepub fn set_write_timeout(&mut self, timeout: Duration) -> Result<()>
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.
sourcepub fn get_write_timeout(&self) -> Result<Duration>
pub fn get_write_timeout(&self) -> Result<Duration>
Get the write timeout of the serial port.
sourcepub fn discard_buffers(&self) -> Result<()>
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.
sourcepub fn discard_input_buffer(&self) -> Result<()>
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.
sourcepub fn discard_output_buffer(&self) -> Result<()>
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.
sourcepub fn set_rts(&self, state: bool) -> Result<()>
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.
sourcepub fn read_cts(&self) -> Result<bool>
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.
sourcepub fn set_dtr(&self, state: bool) -> Result<()>
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.
sourcepub fn read_dsr(&self) -> Result<bool>
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.
Trait Implementations
sourceimpl AsRawFd for SerialPort
impl AsRawFd for SerialPort
sourceimpl FromRawFd for SerialPort
impl FromRawFd for SerialPort
sourceunsafe fn from_raw_fd(fd: RawFd) -> Self
unsafe fn from_raw_fd(fd: RawFd) -> Self
Self
from the given raw file
descriptor. Read moresourceimpl IntoRawFd for SerialPort
impl IntoRawFd for SerialPort
sourcefn into_raw_fd(self) -> RawFd
fn into_raw_fd(self) -> RawFd
sourceimpl Read for SerialPort
impl Read for SerialPort
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
sourcefn read_vectored(&mut self, buf: &mut [IoSliceMut<'_>]) -> Result<usize>
fn read_vectored(&mut self, buf: &mut [IoSliceMut<'_>]) -> Result<usize>
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Read
. Read moresourceimpl Write for SerialPort
impl Write for SerialPort
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
sourcefn write_vectored(&mut self, buf: &[IoSlice<'_>]) -> Result<usize>
fn write_vectored(&mut self, buf: &[IoSlice<'_>]) -> Result<usize>
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)