Module io

Tools and combinators for I/O.

Examples

use futures_lite::io::{self, AsyncReadExt};

let input: &[u8] = b"hello";
let mut reader = io::BufReader::new(input);

let mut contents = String::new();
reader.read_to_string(&mut contents).await?;

Re-exports

pub use std::io::Error;

pub use std::io::ErrorKind;

pub use std::io::Result;

pub use std::io::SeekFrom;

pub use futures_io::AsyncBufRead;

pub use futures_io::AsyncRead;

pub use futures_io::AsyncSeek;

pub use futures_io::AsyncWrite;

Structs

AssertAsync

Asserts that a type implementing std::io traits can be used as an async type.

AsyncAsSync

A wrapper around a type that implements AsyncRead or AsyncWrite that converts Pending polls to WouldBlock errors.

BlockOn

Blocks on all async I/O operations and implements std::io traits.

BufReader

Adds buffering to a reader.

BufWriter

Adds buffering to a writer.

Bytes

Reader for the AsyncReadExt::bytes() method.

Chain

Reader for the AsyncReadExt::chain() method.

CloseFuture

Future for the AsyncWriteExt::close() method.

Cursor

Gives an in-memory buffer a cursor for reading and writing.

Empty

Reader for the empty() function.

FillBuf

Future for the AsyncBufReadExt::fill_buf() method.

FlushFuture

Future for the AsyncWriteExt::flush() method.

Lines

Stream for the AsyncBufReadExt::lines() method.

ReadExactFuture

Future for the AsyncReadExt::read_exact() method.

ReadFuture

Future for the AsyncReadExt::read() method.

ReadHalf

The read half returned by split().

ReadLineFuture

Future for the AsyncBufReadExt::read_line() method.

ReadToEndFuture

Future for the AsyncReadExt::read_to_end() method.

ReadToStringFuture

Future for the AsyncReadExt::read_to_string() method.

ReadUntilFuture

Future for the AsyncBufReadExt::read_until() method.

ReadVectoredFuture

Future for the AsyncReadExt::read_vectored() method.

Repeat

Reader for the repeat() function.

SeekFuture

Future for the AsyncSeekExt::seek() method.

Sink

Writer for the sink() function.

Split

Stream for the AsyncBufReadExt::split() method.

Take

Reader for the AsyncReadExt::take() method.

WriteAllFuture

Future for the AsyncWriteExt::write_all() method.

WriteFuture

Future for the AsyncWriteExt::write() method.

WriteHalf

The write half returned by split().

WriteVectoredFuture

Future for the AsyncWriteExt::write_vectored() method.

Traits

AsyncBufReadExt

Extension trait for AsyncBufRead.

AsyncReadExt

Extension trait for AsyncRead.

AsyncSeekExt

Extension trait for AsyncSeek.

AsyncWriteExt

Extension trait for AsyncWrite.

Functions

copy

Copies the entire contents of a reader into a writer.

empty

Creates an empty reader.

repeat

Creates an infinite reader that reads the same byte repeatedly.

sink

Creates a writer that consumes and drops all data.

split

Splits a stream into AsyncRead and AsyncWrite halves.

Type Aliases

BoxedReader

Type alias for Pin<Box<dyn AsyncRead + Send + 'static>>.

BoxedWriter

Type alias for Pin<Box<dyn AsyncWrite + Send + 'static>>.