Struct serialport::TTYPort

pub struct TTYPort { /* private fields */ }

A serial port implementation for POSIX TTY ports

The port will be closed when the value is dropped. However, this struct should not be instantiated directly by using TTYPort::open(), instead use the cross-platform serialport::open() or serialport::open_with_settings().

Note: on macOS, when connecting to a pseudo-terminal (pty opened via posix_openpt), the baud_rate should be set to 0; this will be used to explicitly skip an attempt to set the baud rate of the file descriptor that would otherwise happen via an ioctl command.

use serialport::{TTYPort, SerialPort};

let (mut master, slave) = TTYPort::pair().expect("Unable to create ptty pair");

// ... elsewhere

let mut port = TTYPort::open(&serialport::new(slave.name().unwrap(), 0)).expect("unable to open");

Implementations

impl TTYPort

pub fn open(builder: &SerialPortBuilder) -> Result<TTYPort>

Opens a TTY device as a serial port.

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

Ports are opened in exclusive mode by default. If this is undesirable behavior, use TTYPort::set_exclusive(false).

If the port settings differ from the default settings, characters received before the new settings become active may be garbled. To remove those from the receive buffer, call TTYPort::clear(ClearBuffer::Input).

Errors

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

pub fn exclusive(&self) -> bool

Returns the exclusivity of the port

If a port is exclusive, then trying to open the same device path again will fail.

pub fn set_exclusive(&mut self, exclusive: bool) -> Result<()>

Sets the exclusivity of the port

If a port is exclusive, then trying to open the same device path again will fail.

See the man pages for the tiocexcl and tiocnxcl ioctl’s for more details.

Errors

• Io for any error while setting exclusivity for the port.

pub fn pair() -> Result<(Self, Self)>

Create a pair of pseudo serial terminals

Returns

Two connected TTYPort objects: (master, slave)

Errors

Attempting any IO or parameter settings on the slave tty after the master tty is closed will return errors.

On some platforms manipulating the master port will fail and only modifying the slave port is possible.

Examples

use serialport::TTYPort;

let (master, slave) = TTYPort::pair().unwrap();

pub fn send_break(&self, duration: BreakDuration) -> Result<()>

Sends 0-valued bits over the port for a set duration

pub fn try_clone_native(&self) -> Result<TTYPort>

Attempts to clone the SerialPort. This allow you to write and read simultaneously from the same serial connection. Please note that if you want a real asynchronous serial port you should look at mio-serial or tokio-serial.

Also, you must be very careful when changing the settings of a cloned SerialPort : since the settings are cached on a per object basis, trying to modify them from two different objects can cause some nasty behavior.

This is the same as SerialPort::try_clone() but returns the concrete type instead.

Errors

This function returns an error if the serial port couldn’t be cloned.

Trait Implementations

impl AsRawFd for TTYPort

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TTYPort

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

Formats the value using the given formatter.

impl Drop for TTYPort

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawFd for TTYPort

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for TTYPort

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

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>

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

fn baud_rate(&self) -> Result<u32>

Returns the port’s baud rate

On some platforms this will be the actual device baud rate, which may differ from the desired baud rate.

fn name(&self) -> Option<String>

Returns the name of this port if it exists.

fn data_bits(&self) -> Result<DataBits>

Returns the character size.

fn flow_control(&self) -> Result<FlowControl>

Returns the flow control mode.

fn parity(&self) -> Result<Parity>

Returns the parity-checking mode.

fn stop_bits(&self) -> Result<StopBits>

Returns the number of stop bits.

fn timeout(&self) -> Duration

Returns the current timeout.

fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>

Sets the baud rate.

fn set_flow_control(&mut self, flow_control: FlowControl) -> Result<()>

Sets the flow control mode.

fn set_parity(&mut self, parity: Parity) -> Result<()>

Sets the parity-checking mode.

fn set_data_bits(&mut self, data_bits: DataBits) -> Result<()>

Sets the character size.

fn set_stop_bits(&mut self, stop_bits: StopBits) -> Result<()>

Sets the number of stop bits.

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

Sets the timeout for future I/O operations.

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

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

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

Writes to the Data Terminal Ready pin

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

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

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

Reads the state of the Data Set Ready control signal.

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

Reads the state of the Ring Indicator control signal.

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

Reads the state of the Carrier Detect control signal.

fn bytes_to_read(&self) -> Result<u32>

Gets the number of bytes available to be read from the input buffer.

fn bytes_to_write(&self) -> Result<u32>

Get the number of bytes written to the output buffer, awaiting transmission.

fn clear(&self, buffer_to_clear: ClearBuffer) -> Result<()>

Discards all bytes from the serial driver’s input buffer and/or output buffer.

fn try_clone(&self) -> Result<Box<dyn SerialPort>>

Attempts to clone the SerialPort. This allow you to write and read simultaneously from the same serial connection. Please note that if you want a real asynchronous serial port you should look at mio-serial or tokio-serial.

fn set_break(&self) -> Result<()>

Start transmitting a break

fn clear_break(&self) -> Result<()>

Stop transmitting a break

impl Write for TTYPort

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

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

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

Flush 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, 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.