A runtime for writing reliable, asynchronous, and slim applications with the Rust programming language.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github draft initial CONTRIBUTING guide (#567) Aug 24, 2018
benches Deprecate executor re-exports (#412) Jun 12, 2018
ci fix tsan errors (#745) Nov 9, 2018
examples tokio: change hello world to new, simpler example (#690) Oct 12, 2018
src rt: fix Builder docs to no longer use deprecated methods (#749) Nov 16, 2018
tests rt: fix `Runtime::reactor()` as used by tokio-core (#721) Oct 25, 2018
tokio-async-await Bump version to v0.1.9 (#666) Sep 27, 2018
tokio-buf Add tokio-buf and a `BufStream` trait (#611) Oct 29, 2018
tokio-channel async-await: track nightly changes (#661) Sep 26, 2018
tokio-codec Bump version to v0.1.9 (#666) Sep 27, 2018
tokio-current-thread Bump version to v0.1.10, fixing minimal versions (#671) Sep 27, 2018
tokio-executor Bump version to v0.1.9 (#666) Sep 27, 2018
tokio-fs chore: bump rand dependency to 0.6 (#753) Nov 16, 2018
tokio-io Bump version to 0.1.12 (#718) Oct 24, 2018
tokio-reactor Bumped crossbeam-utils version (#746) Nov 10, 2018
tokio-signal signal: miscellaneous tweaks and improvements (#751) Nov 16, 2018
tokio-tcp Bump version to v0.1.9 (#666) Sep 27, 2018
tokio-threadpool chore: bump rand dependency to 0.6 (#753) Nov 16, 2018
tokio-timer chore: bump rand dependency to 0.6 (#753) Nov 16, 2018
tokio-tls Spelling fixes (#571) Aug 25, 2018
tokio-udp udp: add `into_parts` to `RecvDgram` (#710) Nov 15, 2018
tokio-uds uds: minor doc fix in UnixStream and UnixDatagram (#754) Nov 16, 2018
.appveyor.yml Set RUST_BACKTRACE=1 on AppVeyor (#650) Sep 19, 2018
.gitignore signal: Initial commit Sep 10, 2018
.travis.yml ci: Run `cargo test` with the --no-fail-fast flag (#635) Sep 15, 2018
CHANGELOG.md Bump version to 0.1.12 (#718) Oct 24, 2018
CONTRIBUTING.md contributing: fix an invalid link (#716) Oct 21, 2018
Cargo.toml Add tokio-buf and a `BufStream` trait (#611) Oct 29, 2018
LICENSE Relicense Tokio exclusively under the MIT license. (#215) Mar 10, 2018
README.md async-await: track nightly changes (#661) Sep 26, 2018

README.md

Tokio

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

  • Fast: Tokio's zero-cost abstractions give you bare-metal performance.

  • Reliable: Tokio leverages Rust's ownership, type system, and concurrency model to reduce bugs and ensure thread safety.

  • Scalable: Tokio has a minimal footprint, and handles backpressure and cancellation naturally.

Crates.io MIT licensed Travis Build Status Appveyor Build Status Gitter chat

Website | Guides | API Docs | Chat

The API docs for the master branch are published here.

Overview

Tokio is an event-driven, non-blocking I/O platform for writing asynchronous applications with the Rust programming language. At a high level, it provides a few major components:

  • A multithreaded, work-stealing based task scheduler.
  • A reactor backed by the operating system's event queue (epoll, kqueue, IOCP, etc...).
  • Asynchronous TCP and UDP sockets.

These components provide the runtime components necessary for building an asynchronous application.

Example

A basic TCP echo server with Tokio:

extern crate tokio;

use tokio::prelude::*;
use tokio::io::copy;
use tokio::net::TcpListener;

fn main() {
    // Bind the server's socket.
    let addr = "127.0.0.1:12345".parse().unwrap();
    let listener = TcpListener::bind(&addr)
        .expect("unable to bind TCP listener");

    // Pull out a stream of sockets for incoming connections
    let server = listener.incoming()
        .map_err(|e| eprintln!("accept failed = {:?}", e))
        .for_each(|sock| {
            // Split up the reading and writing parts of the
            // socket.
            let (reader, writer) = sock.split();

            // A future that echos the data and returns how
            // many bytes were copied...
            let bytes_copied = copy(reader, writer);

            // ... after which we'll print what happened.
            let handle_conn = bytes_copied.map(|amt| {
                println!("wrote {:?} bytes", amt)
            }).map_err(|err| {
                eprintln!("IO error {:?}", err)
            });

            // Spawn the future as a concurrent task.
            tokio::spawn(handle_conn)
        });

    // Start the Tokio runtime
    tokio::run(server);
}

More examples 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-async-await: Experimental async / await support.

  • tokio-codec: Utilities for encoding and decoding protocol frames.

  • tokio-current-thread: Schedule the execution of futures on the current thread.

  • tokio-executor: Task execution related traits and utilities.

  • tokio-fs: Filesystem (and standard in / out) APIs.

  • tokio-io: Asynchronous I/O related traits and utilities.

  • tokio-reactor: Event loop that drives I/O resources (like TCP and UDP sockets).

  • tokio-tcp: TCP bindings for use with tokio-io and tokio-reactor.

  • tokio-threadpool: Schedules the execution of futures across a pool of threads.

  • tokio-timer: Time related APIs.

  • tokio-udp: UDP bindings for use with tokio-io and tokio-reactor.

  • tokio-uds: Unix Domain Socket bindings for use with tokio-io and tokio-reactor.

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.

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tokio by you, shall be licensed as MIT, without any additional terms or conditions.