Module futures_util::io

This is supported on crate feature io only.

IO

This module contains a number of functions for working with AsyncRead, AsyncWrite, AsyncSeek, and AsyncBufRead types, including the AsyncReadExt, AsyncWriteExt, AsyncSeekExt, and AsyncBufReadExt traits which add methods to the AsyncRead, AsyncWrite, AsyncSeek, and AsyncBufRead types.

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

Structs

AllowStdIo	io 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	io The BufReader struct adds buffering to any reader.
BufWriter	io Wraps a writer and buffers its output.
Chain	io Reader for the chain method.
Close	io Future for the close method.
Copy	io Future for the copy() function.
CopyBuf	io Future for the copy_buf() function.
Cursor	io A Cursor wraps an in-memory buffer and provides it with a AsyncSeek implementation.
Empty	io Reader for the empty() function.
Error	io The error type for I/O operations of the Read, Write, Seek, and associated traits.
FillBuf	io Future for the fill_buf method.
Flush	io Future for the flush method.
IntoSink	io and sink Sink for the into_sink method.
IoSlice	io A buffer type used with Write::write_vectored.
IoSliceMut	io A buffer type used with Read::read_vectored.
Initializer	Experimentalio and read-initializer A type used to conditionally initialize buffers passed to Read methods.
Lines	io Stream for the lines method.
Read	io Future for the read method.
ReadExact	io Future for the read_exact method.
ReadHalf	io The readable half of an object returned from AsyncRead::split.
ReadLine	io Future for the read_line method.
ReadToEnd	io Future for the read_to_end method.
ReadToString	io Future for the read_to_string method.
ReadUntil	io Future for the read_until method.
ReadVectored	io Future for the read_vectored method.
Repeat	io Reader for the repeat() function.
ReuniteError	io Error indicating a ReadHalf<T> and WriteHalf<T> were not two halves of a AsyncRead + AsyncWrite, and thus could not be reunited.
Seek	io Future for the seek method.
Sink	io Writer for the sink() function.
Take	io Reader for the take method.
Window	io A owned window around an underlying buffer.
Write	io Future for the write method.
WriteAll	io Future for the write_all method.
WriteAllVectored	io Future for the write_all_vectored method.
WriteHalf	io The writable half of an object returned from AsyncRead::split.
WriteVectored	io Future for the write_vectored method.

Enums

ErrorKind	io A list specifying general categories of I/O error.
SeekFrom	io Enumeration of possible methods to seek within an I/O object.

Traits

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

Functions

copy	io Creates a future which copies all the bytes from one object to another.
copy_buf	io Creates a future which copies all the bytes from one object to another.
empty	io Constructs a new handle to an empty reader.
repeat	io Creates an instance of a reader that infinitely repeats one byte.
sink	io Creates an instance of a writer which will successfully consume all data.

Type Definitions

Result

io A specialized Result type for I/O operations.