Struct tokio_serial::Serial [−][src]
pub struct Serial { /* fields omitted */ }
Serial port I/O struct.
Methods
impl Serial
[src]
impl Serial
pub fn from_path<P>(path: P, settings: &SerialPortSettings) -> Result<Serial> where
P: AsRef<Path>,
[src]
pub fn from_path<P>(path: P, settings: &SerialPortSettings) -> Result<Serial> where
P: AsRef<Path>,
Open serial port from a provided path, using the default reactor.
pub fn from_path_with_handle<P>(
path: P,
settings: &SerialPortSettings,
handle: &Handle
) -> Result<Serial> where
P: AsRef<Path>,
[src]
pub fn from_path_with_handle<P>(
path: P,
settings: &SerialPortSettings,
handle: &Handle
) -> Result<Serial> where
P: AsRef<Path>,
Open serial port from a provided path, using the specified reactor.
pub fn pair() -> Result<(Self, Self)>
[src]
pub fn pair() -> Result<(Self, Self)>
Create a pair of pseudo serial terminals using the default reactor
Returns
Two connected, unnamed Serial
objects.
Errors
Attempting any IO or parameter settings on the slave tty after the master tty is closed will return errors.
pub fn pair_with_handle(handle: &Handle) -> Result<(Self, Self)>
[src]
pub fn pair_with_handle(handle: &Handle) -> Result<(Self, Self)>
Create a pair of pseudo serial terminals using the specified reactor.
Returns
Two connected, unnamed Serial
objects.
Errors
Attempting any IO or parameter settings on the slave tty after the master tty is closed will return errors.
pub fn set_exclusive(&mut self, exclusive: bool) -> Result<()>
[src]
pub fn set_exclusive(&mut self, exclusive: bool) -> Result<()>
Sets the exclusivity of the port
If a port is exclusive, then trying to open the same device path again will fail.
See the man pages for the tiocexcl and tiocnxcl ioctl's for more details.
Errors
Io
for any error while setting exclusivity for the port.
pub fn exclusive(&self) -> bool
[src]
pub fn exclusive(&self) -> bool
Returns the exclusivity of the port
If a port is exclusive, then trying to open the same device path again will fail.
Trait Implementations
impl SerialPort for Serial
[src]
impl SerialPort for Serial
fn settings(&self) -> SerialPortSettings
[src]
fn settings(&self) -> SerialPortSettings
Returns a struct with the current port settings
fn name(&self) -> Option<String>
[src]
fn name(&self) -> Option<String>
Returns the name of this port if it exists. Read more
fn baud_rate(&self) -> Result<u32>
[src]
fn baud_rate(&self) -> Result<u32>
Returns the current baud rate. Read more
fn data_bits(&self) -> Result<DataBits>
[src]
fn data_bits(&self) -> Result<DataBits>
Returns the character size. Read more
fn flow_control(&self) -> Result<FlowControl>
[src]
fn flow_control(&self) -> Result<FlowControl>
Returns the flow control mode. Read more
fn parity(&self) -> Result<Parity>
[src]
fn parity(&self) -> Result<Parity>
Returns the parity-checking mode. Read more
fn stop_bits(&self) -> Result<StopBits>
[src]
fn stop_bits(&self) -> Result<StopBits>
Returns the number of stop bits. Read more
fn timeout(&self) -> Duration
[src]
fn timeout(&self) -> Duration
Returns the current timeout.
fn set_all(&mut self, settings: &SerialPortSettings) -> Result<()>
[src]
fn set_all(&mut self, settings: &SerialPortSettings) -> Result<()>
Applies all settings for a struct. This isn't guaranteed to involve only a single call into the driver, though that may be done on some platforms. Read more
fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>
[src]
fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>
Sets the baud rate. Read more
fn set_data_bits(&mut self, data_bits: DataBits) -> Result<()>
[src]
fn set_data_bits(&mut self, data_bits: DataBits) -> Result<()>
Sets the character size.
fn set_flow_control(&mut self, flow_control: FlowControl) -> Result<()>
[src]
fn set_flow_control(&mut self, flow_control: FlowControl) -> Result<()>
Sets the flow control mode.
fn set_parity(&mut self, parity: Parity) -> Result<()>
[src]
fn set_parity(&mut self, parity: Parity) -> Result<()>
Sets the parity-checking mode.
fn set_stop_bits(&mut self, stop_bits: StopBits) -> Result<()>
[src]
fn set_stop_bits(&mut self, stop_bits: StopBits) -> Result<()>
Sets the number of stop bits.
fn set_timeout(&mut self, _: Duration) -> Result<()>
[src]
fn set_timeout(&mut self, _: Duration) -> Result<()>
Sets the timeout for future I/O operations.
fn write_request_to_send(&mut self, level: bool) -> Result<()>
[src]
fn write_request_to_send(&mut self, level: bool) -> Result<()>
Sets the state of the RTS (Request To Send) control signal. Read more
fn write_data_terminal_ready(&mut self, level: bool) -> Result<()>
[src]
fn write_data_terminal_ready(&mut self, level: bool) -> Result<()>
Writes to the Data Terminal Ready pin Read more
fn read_clear_to_send(&mut self) -> Result<bool>
[src]
fn read_clear_to_send(&mut self) -> Result<bool>
Reads the state of the CTS (Clear To Send) control signal. Read more
fn read_data_set_ready(&mut self) -> Result<bool>
[src]
fn read_data_set_ready(&mut self) -> Result<bool>
Reads the state of the Data Set Ready control signal. Read more
fn read_ring_indicator(&mut self) -> Result<bool>
[src]
fn read_ring_indicator(&mut self) -> Result<bool>
Reads the state of the Ring Indicator control signal. Read more
fn read_carrier_detect(&mut self) -> Result<bool>
[src]
fn read_carrier_detect(&mut self) -> Result<bool>
Reads the state of the Carrier Detect control signal. Read more
fn try_clone(&self) -> Result<Box<SerialPort>>
[src]
fn try_clone(&self) -> Result<Box<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. Read more
impl Read for Serial
[src]
impl Read for Serial
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
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. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
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
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill buf
. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn bytes(self) -> Bytes<Self>
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>fn chars(self) -> Chars<Self>
[src]
fn chars(self) -> Chars<Self>
: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples
🔬 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 [char
]s. Read more
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
Creates an adaptor which will chain this stream with another. Read more
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
fn take(self, limit: u64) -> Take<Self>
Creates an adaptor which will read at most limit
bytes from it. Read more
impl Write for Serial
[src]
impl Write for Serial
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
Writes a formatted string into this writer, returning any error encountered. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Write
. Read more
impl AsRawFd for Serial
[src]
impl AsRawFd for Serial
impl AsyncRead for Serial
[src]
impl AsyncRead for Serial
fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>>
[src]
fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>>
Attempt to read from the AsyncRead
into buf
. Read more
unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool
[src]
unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool
Prepares an uninitialized buffer to be safe to pass to read
. Returns true
if the supplied buffer was zeroed out. Read more
fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: BufMut,
[src]
fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: BufMut,
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
: Use tokio_codec::Decoder::framed instead
Provides a Stream
and Sink
interface for reading and writing to this Io
object, using Decode
and Encode
to read and write the raw data. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more
impl AsyncWrite for Serial
[src]
impl AsyncWrite for Serial
fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>>
[src]
fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>>
Attempt to write bytes from buf
into the object. Read more
fn shutdown(&mut self) -> Poll<(), Error>
[src]
fn shutdown(&mut self) -> Poll<(), Error>
Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down. Read more
fn poll_flush(&mut self) -> Result<Async<()>, Error>
[src]
fn poll_flush(&mut self) -> Result<Async<()>, Error>
Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: Buf,
[src]
fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: Buf,
Write a Buf
into this value, returning how many bytes were written. Read more