Module futures_util::io

Asynchronous I/O.

This module is the asynchronous version of std::io. It defines four traits, AsyncRead, AsyncWrite, AsyncSeek, and AsyncBufRead, which mirror the Read, Write, Seek, and BufRead traits of the standard library. However, these traits integrate with the asynchronous task system, so that if an I/O object isn’t ready for reading (or writing), the thread is not blocked, and instead the current task is queued to be woken when I/O is ready.

In addition, the AsyncReadExt, AsyncWriteExt, AsyncSeekExt, and AsyncBufReadExt extension traits offer a variety of useful combinators for operating with asynchronous I/O objects, including ways to work with them using futures, streams and sinks.

This module is only available when the std feature of this library is activated, and it is activated by default.

Re-exports

• pub use std::io::Error;
• pub use std::io::ErrorKind;
• pub use std::io::IoSlice;
• pub use std::io::IoSliceMut;
• pub use std::io::Result;
• pub use std::io::SeekFrom;

Modules

• allow_std 🔒
• buf_reader 🔒
• buf_writer 🔒
• chain 🔒
• close 🔒
• copy 🔒
• copy_buf 🔒
• copy_buf_abortable 🔒
• cursor 🔒
• empty 🔒
• fill_buf 🔒
• flush 🔒
• into_sink 🔒
• line_writer 🔒
• lines 🔒
• read 🔒
• read_exact 🔒
• read_line 🔒
• read_to_end 🔒
• read_to_string 🔒
• read_until 🔒
• read_vectored 🔒
• repeat 🔒
• seek 🔒
• sink 🔒
• split 🔒
• take 🔒
• window 🔒
• write 🔒
• write_all 🔒
• write_vectored 🔒

Structs

• AllowStdIo
  A simple wrapper type which allows types which implement only implement std::io::Read or std::io::Write to be used in contexts which expect an AsyncRead or AsyncWrite.
• BufReader
  The BufReader struct adds buffering to any reader.
• BufWriter
  Wraps a writer and buffers its output.
• Chain
  Reader for the chain method.
• Close
  Future for the close method.
• Copy
  Future for the copy() function.
• CopyBuf
  Future for the copy_buf() function.
• CopyBufAbortable
  Future for the copy_buf_abortable() function.
• Cursor
  A Cursor wraps an in-memory buffer and provides it with a AsyncSeek implementation.
• Empty
  Reader for the empty() function.
• FillBuf
  Future for the fill_buf method.
• Flush
  Future for the flush method.
• IntoSink
  Sink for the into_sink method.
• LineWriter
  Wrap a writer, like BufWriter does, but prioritizes buffering lines
• Lines
  Stream for the lines method.
• Read
  Future for the read method.
• ReadExact
  Future for the read_exact method.
• ReadHalf
  The readable half of an object returned from AsyncRead::split.
• ReadLine
  Future for the read_line method.
• ReadToEnd
  Future for the read_to_end method.
• ReadToString
  Future for the read_to_string method.
• ReadUntil
  Future for the read_until method.
• ReadVectored
  Future for the read_vectored method.
• Repeat
  Reader for the repeat() function.
• ReuniteError
  Error indicating a ReadHalf<T> and WriteHalf<T> were not two halves of a AsyncRead + AsyncWrite, and thus could not be reunited.
• SeeKRelative
  Future for the BufReader::seek_relative method.
• Seek
  Future for the seek method.
• Sink
  Writer for the sink() function.
• Take
  Reader for the take method.
• Window
  An owned window around an underlying buffer.
• Write
  Future for the write method.
• WriteAll
  Future for the write_all method.
• WriteHalf
  The writable half of an object returned from AsyncRead::split.
• WriteVectored
  Future for the write_vectored method.

Constants

• DEFAULT_BUF_SIZE 🔒

Traits

• AsyncBufRead
  Read bytes asynchronously.
• AsyncBufReadExt
  An extension trait which adds utility methods to AsyncBufRead types.
• AsyncRead
  Read bytes asynchronously.
• AsyncReadExt
  An extension trait which adds utility methods to AsyncRead types.
• AsyncSeek
  Seek bytes asynchronously.
• AsyncSeekExt
  An extension trait which adds utility methods to AsyncSeek types.
• AsyncWrite
  Write bytes asynchronously.
• AsyncWriteExt
  An extension trait which adds utility methods to AsyncWrite types.

Functions

• assert_read 🔒
• assert_write 🔒
• copy
  Creates a future which copies all the bytes from one object to another.
• copy_buf
  Creates a future which copies all the bytes from one object to another.
• copy_buf_abortable
  Creates a future which copies all the bytes from one object to another, with its AbortHandle.
• empty
  Constructs a new handle to an empty reader.
• initialize 🔒 ^⚠
  Initializes a buffer if necessary.
• repeat
  Creates an instance of a reader that infinitely repeats one byte.
• sink
  Creates an instance of a writer which will successfully consume all data.