Struct ferrous_serialport::COMPort

pub struct COMPort { /* fields omitted */ }

A serial port implementation for Windows COM ports

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

Implementations

impl COMPort

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

Opens a COM port as a serial device.

port should be the name of a COM port, e.g., COM1.

If the COM port handle needs to be opened with special flags, use from_raw_handle method to create the COMPort. Note that you should set the different settings before using the serial port using set_all.

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 I/O error while opening or initializing the device.

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

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 AsRawHandle for COMPort

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

impl Debug for COMPort

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

Formats the value using the given formatter.

impl Drop for COMPort

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawHandle for COMPort

unsafe fn from_raw_handle(handle: RawHandle) -> Self

Constructs a new I/O object from the specified raw handle.

impl Read for COMPort

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.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

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

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Send for COMPort

impl SerialPort for COMPort

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

Returns the name of this port if it exists.

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 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 baud_rate(&self) -> Result<u32>

Returns the current baud rate.

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

Returns the character size.

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

Returns the parity-checking mode.

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

Returns the number of stop bits.

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

Returns the flow control mode.

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_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_flow_control(&mut self, flow_control: FlowControl) -> Result<()>

Sets the flow control mode.

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 COMPort

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.

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

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

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

pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

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

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Write.