README.md

Tokio

NOTE: Tokio's master is currently undergoing heavy development. This branch and the alpha releases will see API breaking changes and there are currently significant performance regressions that still need to be fixed before the final release. Use the v0.1.x branch for stable releases.

A runtime for writing reliable, asynchronous, and slim applications with
the Rust programming language. It is:

More examples can be found here. Note that the master branch
is currently being updated to use async / await. The examples are
not fully ported. Examples for stable Tokio can be found
here.

Getting Help

First, see if the answer to your question can be found in the Guides or the
API documentation. If the answer is not there, there is an active community in
the Tokio Gitter channel. We would be happy to try to answer your
question. Last, if that doesn't work, try opening an issue with the question.

Contributing

🎈 Thanks for your help improving the project! We are so happy to have
you! We have a contributing guide to help you get involved in the Tokio
project.

Project layout

The tokio crate, found at the root, is primarily intended for use by
application developers. Library authors should depend on the sub crates, which
have greater guarantees of stability.

The crates included as part of Tokio are:

tokio-executor: Task executors and related utilities. Includes a
single-threaded executor and a multi-threaded, work-stealing, executor.

bytes: Utilities for working with bytes, including efficient byte buffers.

Supported Rust Versions

Tokio is built against the latest stable, nightly, and beta Rust releases. The
minimum version supported is the stable release from three months before the
current stable release version. For example, if the latest stable Rust is 1.29,
the minimum version supported is 1.26. The current Tokio version is not
guaranteed to build on Rust versions earlier than the minimum supported version.