Struct mio_serial::SerialStream
source · pub struct SerialStream { /* private fields */ }
Expand description
SerialStream
Implementations§
source§impl SerialStream
impl SerialStream
sourcepub fn open(builder: &SerialPortBuilder) -> Result<Self>
pub fn open(builder: &SerialPortBuilder) -> Result<Self>
Open a nonblocking serial port from the provided builder
Example
use mio_serial::{SerialPortBuilder, SerialStream};
use std::path::Path;
let args = mio_serial::new("/dev/ttyUSB0", 9600);
let serial = SerialStream::open(&args).unwrap();
Trait Implementations§
source§impl AsRawHandle for SerialStream
impl AsRawHandle for SerialStream
source§fn as_raw_handle(&self) -> RawHandle
fn as_raw_handle(&self) -> RawHandle
source§impl Debug for SerialStream
impl Debug for SerialStream
source§impl FromRawHandle for SerialStream
impl FromRawHandle for SerialStream
source§unsafe fn from_raw_handle(handle: RawHandle) -> Self
unsafe fn from_raw_handle(handle: RawHandle) -> Self
This method can potentially fail to override the communication timeout
value set in sys::override_comm_timeouts
without any indication to the user.
source§impl IntoRawHandle for SerialStream
impl IntoRawHandle for SerialStream
source§fn into_raw_handle(self) -> RawHandle
fn into_raw_handle(self) -> RawHandle
source§impl Read for SerialStream
impl Read for SerialStream
source§fn read(&mut self, bytes: &mut [u8]) -> StdIoResult<usize>
fn read(&mut self, bytes: &mut [u8]) -> StdIoResult<usize>
1.36.0 · source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn 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 · source§fn 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 · source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)source§fn 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 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read moresource§impl SerialPort for SerialStream
impl SerialPort for SerialStream
source§fn baud_rate(&self) -> Result<u32>
fn baud_rate(&self) -> Result<u32>
Returns the current baud rate.
This function returns None
if the baud rate could not be determined. This may occur if
the hardware is in an uninitialized state. Setting a baud rate with set_baud_rate()
should initialize the baud rate to a supported value.
source§fn data_bits(&self) -> Result<DataBits>
fn data_bits(&self) -> Result<DataBits>
Returns the character size.
This function returns None
if the character size could not be determined. This may occur
if the hardware is in an uninitialized state or is using a non-standard character size.
Setting a baud rate with set_char_size()
should initialize the character size to a
supported value.
source§fn flow_control(&self) -> Result<FlowControl>
fn flow_control(&self) -> Result<FlowControl>
Returns the flow control mode.
This function returns None
if the flow control mode could not be determined. This may
occur if the hardware is in an uninitialized state or is using an unsupported flow control
mode. Setting a flow control mode with set_flow_control()
should initialize the flow
control mode to a supported value.
source§fn parity(&self) -> Result<Parity>
fn parity(&self) -> Result<Parity>
Returns the parity-checking mode.
This function returns None
if the parity mode could not be determined. This may occur if
the hardware is in an uninitialized state or is using a non-standard parity mode. Setting
a parity mode with set_parity()
should initialize the parity mode to a supported value.
source§fn stop_bits(&self) -> Result<StopBits>
fn stop_bits(&self) -> Result<StopBits>
Returns the number of stop bits.
This function returns None
if the number of stop bits could not be determined. This may
occur if the hardware is in an uninitialized state or is using an unsupported stop bit
configuration. Setting the number of stop bits with set_stop-bits()
should initialize the
stop bits to a supported value.
source§fn timeout(&self) -> Duration
fn timeout(&self) -> Duration
Returns the current timeout. This parameter is const and equal to zero and implemented due to required for trait completeness.
source§fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>
fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>
Sets the baud rate.
Errors
If the implementation does not support the requested baud rate, this function may return an
InvalidInput
error. Even if the baud rate is accepted by set_baud_rate()
, it may not be
supported by the underlying hardware.
source§fn set_flow_control(&mut self, flow_control: FlowControl) -> Result<()>
fn set_flow_control(&mut self, flow_control: FlowControl) -> Result<()>
Sets the flow control mode.
source§fn set_timeout(&mut self, _: Duration) -> Result<()>
fn set_timeout(&mut self, _: Duration) -> Result<()>
Sets the timeout for future I/O operations. This parameter is ignored but required for trait completeness.
source§fn write_request_to_send(&mut self, level: bool) -> Result<()>
fn write_request_to_send(&mut self, level: bool) -> Result<()>
Sets the state of the RTS (Request To Send) control signal.
Setting a value of true
asserts the RTS control signal. false
clears the signal.
Errors
This function returns an error if the RTS control signal could not be set to the desired state on the underlying hardware:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn write_data_terminal_ready(&mut self, level: bool) -> Result<()>
fn write_data_terminal_ready(&mut self, level: bool) -> Result<()>
Writes to the Data Terminal Ready pin
Setting a value of true
asserts the DTR control signal. false
clears the signal.
Errors
This function returns an error if the DTR control signal could not be set to the desired state on the underlying hardware:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn read_clear_to_send(&mut self) -> Result<bool>
fn read_clear_to_send(&mut self) -> Result<bool>
Reads the state of the CTS (Clear To Send) control signal.
This function returns a boolean that indicates whether the CTS control signal is asserted.
Errors
This function returns an error if the state of the CTS control signal could not be read from the underlying hardware:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn read_data_set_ready(&mut self) -> Result<bool>
fn read_data_set_ready(&mut self) -> Result<bool>
Reads the state of the Data Set Ready control signal.
This function returns a boolean that indicates whether the DSR control signal is asserted.
Errors
This function returns an error if the state of the DSR control signal could not be read from the underlying hardware:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn read_ring_indicator(&mut self) -> Result<bool>
fn read_ring_indicator(&mut self) -> Result<bool>
Reads the state of the Ring Indicator control signal.
This function returns a boolean that indicates whether the RI control signal is asserted.
Errors
This function returns an error if the state of the RI control signal could not be read from the underlying hardware:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn read_carrier_detect(&mut self) -> Result<bool>
fn read_carrier_detect(&mut self) -> Result<bool>
Reads the state of the Carrier Detect control signal.
This function returns a boolean that indicates whether the CD control signal is asserted.
Errors
This function returns an error if the state of the CD control signal could not be read from the underlying hardware:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn bytes_to_read(&self) -> Result<u32>
fn bytes_to_read(&self) -> Result<u32>
Gets the number of bytes available to be read from the input buffer.
Errors
This function may return the following errors:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn bytes_to_write(&self) -> Result<u32>
fn bytes_to_write(&self) -> Result<u32>
Get the number of bytes written to the output buffer, awaiting transmission.
Errors
This function may return the following errors:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn clear(&self, buffer_to_clear: ClearBuffer) -> Result<()>
fn clear(&self, buffer_to_clear: ClearBuffer) -> Result<()>
Discards all bytes from the serial driver’s input buffer and/or output buffer.
Errors
This function may return the following errors:
NoDevice
if the device was disconnected.Io
for any other type of I/O error.
source§fn try_clone(&self) -> Result<Box<dyn SerialPort>>
fn try_clone(&self) -> Result<Box<dyn SerialPort>>
Cloning is not supported for SerialStream objects
This logic has never really completely worked. Cloned file descriptors in asynchronous code is a semantic minefield. Are you cloning the file descriptor? Are you cloning the event flags on the file descriptor? Both? It’s a bit of a mess even within one OS, let alone across multiple OS’s
Maybe it can be done with more work, but until a clear use-case is required (or mio/tokio
gets an equivalent of the unix AsyncFd
for async file handles, see
https://github.com/tokio-rs/tokio/issues/3781 and
https://github.com/tokio-rs/tokio/pull/3760#issuecomment-839854617) I would rather not
have any code available over a kind-of-works-maybe impl. So I’ll leave this code here
for now but hard-code it disabled.
source§fn clear_break(&self) -> Result<()>
fn clear_break(&self) -> Result<()>
Stop transmitting a break
source§impl Source for SerialStream
impl Source for SerialStream
source§fn register(
&mut self,
registry: &Registry,
token: Token,
interest: Interest
) -> StdIoResult<()>
fn register(
&mut self,
registry: &Registry,
token: Token,
interest: Interest
) -> StdIoResult<()>
source§fn reregister(
&mut self,
registry: &Registry,
token: Token,
interest: Interest
) -> StdIoResult<()>
fn reregister(
&mut self,
registry: &Registry,
token: Token,
interest: Interest
) -> StdIoResult<()>
source§fn deregister(&mut self, registry: &Registry) -> StdIoResult<()>
fn deregister(&mut self, registry: &Registry) -> StdIoResult<()>
source§impl TryFrom<COMPort> for SerialStream
impl TryFrom<COMPort> for SerialStream
source§impl Write for SerialStream
impl Write for SerialStream
source§fn write(&mut self, bytes: &[u8]) -> StdIoResult<usize>
fn write(&mut self, bytes: &[u8]) -> StdIoResult<usize>
source§fn flush(&mut self) -> StdIoResult<()>
fn flush(&mut self) -> StdIoResult<()>
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)