Struct AsyncSerial

pub struct AsyncSerial { /* private fields */ }

Serial port I/O struct.

Implementations

impl AsyncSerial

pub fn from_builder(builder: &SerialPortBuilder) -> Result<AsyncSerial>

Open a non-blocking tokio-compatible serial port from the provided port.

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

Create a pair of pseudo serial terminals using the default reactor

Returns

Two connected, unnamed Serial objects.

Errors

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

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

Trait Implementations

impl AsRawFd for AsyncSerial

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for AsyncSerial

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for AsyncSerial

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Read for AsyncSerial

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

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

Start transmitting a break

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

Stop transmitting a break

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

Returns the name of this port if it exists.

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

Returns the current baud rate.

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_data_bits(&mut self, data_bits: DataBits) -> Result<()>

Sets the character size.

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_stop_bits(&mut self, stop_bits: StopBits) -> Result<()>

Sets the number of stop bits.

fn set_timeout(&mut self, _: 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.

impl Write for AsyncSerial

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.