Struct tokio_serial::SerialPort

pub struct SerialPort { /* fields omitted */ }

A structure representing an open serial port.

Methods

impl SerialPort

fn open_with_settings<T: AsRef<OsStr> + ?Sized>(port_name: &T,
                                                settings: &PortSettings,
                                                handle: &Handle)
                                                -> Result<SerialPort>

open serial port named by port_name with custom settings.

fn try_clone(&self, handle: &Handle) -> Result<SerialPort>

Creates a new independently owned handle to the underlying serial port.

The returned SerialPort is a reference to the same state that this object references. Both handles will read and write.

fn poll_read(&self) -> Async<()>

Test whether this serial port is ready to be read or not.

fn poll_write(&self) -> Async<()>

Test whether this serial port is ready to be written to or not.

Trait Implementations

impl AsRawFd for SerialPort

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Read for SerialPort

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

Unstable (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 SerialPort

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

fn poll_read(&mut self) -> Async<()>

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>

Tests to see if this I/O object may be writable.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)

Helper method for splitting this read/write object into two halves.

impl<'a> Read for &'a SerialPort

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

Unstable (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<'a> Write for &'a SerialPort

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<'a> Io for &'a SerialPort

fn poll_read(&mut self) -> Async<()>

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>

Tests to see if this I/O object may be writable.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)

Helper method for splitting this read/write object into two halves.

impl Debug for SerialPort

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

Formats the value using the given formatter.