Struct SerialPortStream 

pub struct SerialPortStream { /* private fields */ }

An opened serial port for async reads and writes.

Read behavior

• Unix: AsyncRead polls the port fd directly via async-io.
• Windows: AsyncRead uses overlapped ReadFile with a windows thread-pool completion.

Enable the stream feature for Stream / SerialPortStream::try_poll_next. That starts a background receive pump and FIFO on both platforms. With stream enabled, AsyncRead and Stream both read from the same FIFO.

Write behavior

Both platforms use direct async polling (async-io on Unix, overlapped WriteFile + windows thread-pool completion).

Example

use serialport_stream::new;
use futures::io::{AsyncReadExt, AsyncWriteExt};

let mut stream = new("COM3", 115200).open()?;
stream.write_all(&[0x0a, 0xC0]).await?;
let mut buf = [0u8; 256];
let n = stream.read(&mut buf).await?;

Implementations

impl SerialPortStream

pub fn try_poll_next( &mut self, cx: &mut Context<'_>, ) -> Poll<Option<Result<Vec<u8>, Error>>>

Polls for the next received chunk, same as Stream::poll_next.

When ready, returns Poll::Ready(Some(Ok(vec))) with every byte currently buffered in the receive FIFO, or Poll::Pending if the pump thread has not yet delivered data.

Requires the stream Cargo feature.

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

Sets the baud rate (bits per second) on an already-open port.

Other line settings (data bits, parity, stop bits, flow control) remain unchanged.

Trait Implementations

impl AsyncRead for SerialPortStream

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for SerialPortStream

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

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

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for SerialPortStream

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

Formats the value using the given formatter.

impl Send for SerialPortStream

impl Stream for SerialPortStream

Available on crate feature stream only.

type Item = Result<Vec<u8>, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl Sync for SerialPortStream