Struct TTYPort

pub struct TTYPort { /* private fields */ }

A TTY-based serial port implementation.

The port will be closed when the value is dropped.

Implementations

impl TTYPort

pub fn open(path: &Path) -> Result<Self>

Opens a TTY device as a serial port.

path should be the path to a TTY device, e.g., /dev/ttyS0.

use std::path::Path;

serial::posix::TTYPort::open(Path::new("/dev/ttyS0")).unwrap();

Errors

• NoDevice if the device could not be opened. This could indicate that the device is already in use.
• InvalidInput if port is not a valid device name.
• Io for any other error while opening or initializing the device.

Trait Implementations

impl AsRawFd for TTYPort

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Drop for TTYPort

fn drop(&mut self)

Executes the destructor for this type.

impl Read for TTYPort

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

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 SerialDevice for TTYPort

type Settings = TTYSettings

A type that implements the settings for the serial port device.

fn read_settings(&self) -> Result<TTYSettings>

Returns the device’s current settings.

fn write_settings(&mut self, settings: &TTYSettings) -> Result<()>

Applies new settings to the serial device.

fn timeout(&self) -> Duration

Returns the current timeout.

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

Sets the timeout for future I/O operations.

fn set_rts(&mut self, level: bool) -> Result<()>

Sets the state of the RTS (Request To Send) control signal.

fn set_dtr(&mut self, level: bool) -> Result<()>

Sets the state of the DTR (Data Terminal Ready) control signal.

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

Reads the state of the CTS (Clear To Send) control signal.

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

Reads the state of the DSR (Data Set Ready) control signal.

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

Reads the state of the RI (Ring Indicator) control signal.

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

Reads the state of the CD (Carrier Detect) control signal.

impl Write for TTYPort

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

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

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

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

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

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

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.