Module io

Traits, helpers, and type definitions for asynchronous I/O functionality.

This module is the asynchronous version of std::io. Primarily, it defines two traits, AsyncRead and AsyncWrite, which are asynchronous versions of the Read and Write traits in the standard library.

AsyncRead and AsyncWrite

Like the standard library’s Read and Write traits, AsyncRead and AsyncWrite provide the most general interface for reading and writing input and output. Unlike the standard library’s traits, however, they are asynchronous — meaning that reading from or writing to a tokio::io type will yield to the Tokio scheduler when IO is not ready, rather than blocking. This allows other tasks to run while waiting on IO.

Another difference is that AsyncRead and AsyncWrite only contain core methods needed to provide asynchronous reading and writing functionality. Instead, utility methods are defined in the AsyncReadExt and AsyncWriteExt extension traits. These traits are automatically implemented for all values that implement AsyncRead and AsyncWrite respectively.

End users will rarely interact directly with AsyncRead and AsyncWrite. Instead, they will use the async functions defined in the extension traits. Library authors are expected to implement AsyncRead and AsyncWrite in order to provide types that behave like byte streams.

Even with these differences, Tokio’s AsyncRead and AsyncWrite traits can be used in almost exactly the same manner as the standard library’s Read and Write. Most types in the standard library that implement Read and Write have asynchronous equivalents in tokio that implement AsyncRead and AsyncWrite, such as File and TcpStream.

For example, the standard library documentation introduces Read by demonstrating reading some bytes from a std::fs::File. We can do the same with tokio::fs::File:

use tokio::io::{self, AsyncReadExt};
use tokio::fs::File;

#[tokio::main]
async fn main() -> io::Result<()> {
    let mut f = File::open("foo.txt").await?;
    let mut buffer = [0; 10];

    // read up to 10 bytes
    let n = f.read(&mut buffer).await?;

    println!("The bytes: {:?}", &buffer[..n]);
    Ok(())
}

Buffered Readers and Writers

Byte-based interfaces are unwieldy and can be inefficient, as we’d need to be making near-constant calls to the operating system. To help with this, std::io comes with support for buffered readers and writers, and therefore, tokio::io does as well.

Tokio provides an async version of the std::io::BufRead trait, AsyncBufRead; and async BufReader and BufWriter structs, which wrap readers and writers. These wrappers use a buffer, reducing the number of calls and providing nicer methods for accessing exactly what you want.

For example, BufReader works with the AsyncBufRead trait to add extra methods to any async reader:

use tokio::io::{self, BufReader, AsyncBufReadExt};
use tokio::fs::File;

#[tokio::main]
async fn main() -> io::Result<()> {
    let f = File::open("foo.txt").await?;
    let mut reader = BufReader::new(f);
    let mut buffer = String::new();

    // read a line into buffer
    reader.read_line(&mut buffer).await?;

    println!("{}", buffer);
    Ok(())
}

BufWriter doesn’t add any new ways of writing; it just buffers every call to write:

use tokio::io::{self, BufWriter, AsyncWriteExt};
use tokio::fs::File;

#[tokio::main]
async fn main() -> io::Result<()> {
    let f = File::create("foo.txt").await?;
    {
        let mut writer = BufWriter::new(f);

        // write a byte to the buffer
        writer.write(&[42u8]).await?;

    } // the buffer is flushed once writer goes out of scope

    Ok(())
}

Implementing AsyncRead and AsyncWrite

Because they are traits, we can implement AsyncRead and AsyncWrite for our own types, as well. Note that these traits must only be implemented for non-blocking I/O types that integrate with the futures type system. In other words, these types must never block the thread, and instead the current task is notified when the I/O resource is ready.

Standard input and output

Tokio provides asynchronous APIs to standard input, output, and error. These APIs are very similar to the ones provided by std, but they also implement AsyncRead and AsyncWrite.

Note that the standard input / output APIs must be used from the context of the Tokio runtime, as they require Tokio-specific features to function. Calling these functions outside of a Tokio runtime will panic.

std re-exports

Additionally, Error, ErrorKind, and Result are re-exported from std::io for ease of use.

Structs

BufReaderio-util

The BufReader struct adds buffering to any reader.

BufStreamio-util

Wraps a type that is AsyncWrite and AsyncRead, and buffers its input and output.

BufWriterio-util

Wraps a writer and buffers its output.

Copyio-util

A future that asynchronously copies the entire contents of a reader into a writer.

Emptyio-util

An async reader which is always at EOF.

Errorio-util

The error type for I/O operations of the Read, Write, Seek, and associated traits.

Linesio-util

Stream for the lines method.

PollEventedio-driver

Associates an I/O resource that implements the std::io::Read and/or std::io::Write traits with the reactor that drives it.

ReadHalfio-util

The readable half of a value returned from split.

Registrationio-driver

Associates an I/O resource with the reactor instance that drives it.

Repeatio-util

An async reader which yields one byte over and over and over and over and over and…

Seekio-util

Future for the seek method.

Sinkio-util

An async writer which will move data into the void.

Splitio-util

Stream for the split method.

Stderrio-std

A handle to the standard error stream of a process.

Stdinio-std

A handle to the standard input stream of a process.

Stdoutio-std

A handle to the standard output stream of a process.

Takeio-util

Stream for the take method.

WriteHalfio-util

The writable half of a value returned from split.

Enums

ErrorKindio-util

A list specifying general categories of I/O error.

Traits

AsyncBufRead

Read bytes asynchronously.

AsyncBufReadExtio-util

An extension trait which adds utility methods to AsyncBufRead types.

AsyncRead

Read bytes from a source.

AsyncReadExtio-util

Read bytes from a source.

AsyncSeek

Seek bytes asynchronously.

AsyncSeekExtio-util

An extension trait which adds utility methods to AsyncSeek types.

AsyncWrite

Writes bytes asynchronously.

AsyncWriteExtio-util

Write bytes to a sink.

Functions

copyio-util

Asynchronously copies the entire contents of a reader into a writer.

emptyio-util

Creates a new empty async reader.

repeatio-util

Creates an instance of an async reader that infinitely repeats one byte.

sinkio-util

Creates an instance of an async writer which will successfully consume all data.

splitio-util

Split a single value implementing AsyncRead + AsyncWrite into separate AsyncRead and AsyncWrite handles.

stderrio-std

Constructs a new handle to the standard error of the current process.

stdinio-std

Constructs a new handle to the standard input of the current process.

stdoutio-std

Constructs a new handle to the standard output of the current process.

Type Aliases

Resultio-util

A specialized Result type for I/O operations.