Struct serial_windows::COMPort

pub struct COMPort { /* fields omitted */ }

A serial port implementation for Windows COM ports.

The port will be closed when the value is dropped.

Methods

impl COMPort

fn open<T: AsRef<OsStr> + ?Sized>(port: &T) -> Result<Self>

Opens a COM port as a serial device.

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

serial_windows::COMPort::open("COM1").unwrap();

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.

Trait Implementations

impl Send for COMPort

impl Drop for COMPort

fn drop(&mut self)

A method called when the value goes out of scope.

impl AsRawHandle for COMPort

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

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.

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.

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, placing them into buf.

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for COMPort

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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

Creates a "by reference" adaptor for this instance of Write.

impl SerialDevice for COMPort

type Settings = COMSettings

A type that implements the settings for the serial port device.

fn read_settings(&self) -> Result<COMSettings>

Returns the device's current settings.

fn write_settings(&mut self, settings: &COMSettings) -> Result<()>

Applies new settings to the serial device.

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 set_rts(&mut self, level: bool) -> Result<()>

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

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

Sets the state of the DTR (Data Terminal Ready) control signal.

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

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

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

Reads the state of the DSR (Data Set Ready) control signal.

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

Reads the state of the RI (Ring Indicator) control signal.

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

Reads the state of the CD (Carrier Detect) control signal.