simudream / mio

Metal IO library for Rust

MIO - Metal IO

MIO is a lightweight IO library for Rust with a focus on adding as little overhead as possible over the OS abstractions.

Getting started guide

Currently a work in progress: Getting Started. Feedback can be posted on the PR.

API documentation

• master
• v0.4
• v0.3

Usage

To use mio, first add this to your Cargo.toml:

[dependencies]
mio = "0.4"

Then, add this to your crate root:

extern crate mio;

Features

• Event loop backed by epoll, kqueue.
• Zero allocations at runtime
• Non-blocking TCP, UDP and Unix domain sockets
• High performance timer system
• Thread safe message channel for cross thread communication

Eventually

• Signal handling
• Windows support

Non goals

The following are specifically omitted from MIO and are left to the user or higher level libraries.

• File operations
• Thread pools / multi-threaded event loop

Platforms

Currently, MIO only supports Linux and Darwin. The goal is to support all platforms that support Rust and the readiness IO model.

Resources

Please submit PRs containing links to MIO resources.

• Mio Rustcamp talk
• My Basic Understanding of mio and Asynchronous IO
• Creating A Multi-echo Server using Rust and mio
• Writing Scalable Chat Service from Scratch
• Design Notes About Rotor Library

Libraries

• Eventual IO - Proof of concept TCP library built on top of Mio and Eventual's futures & streams.
• mioco - Mio COroutines
• simplesched - Coroutine I/O with a simple scheduler
• coio-rs - Coroutine I/O with work-stealing scheduler
• rotor - A wrapper that allows to create composable I/O libraries on top of mio
• ws-rs - WebSockets based on Mio

Community

A group of mio users hang out in the #mio channel on the Mozilla IRC server (irc.mozilla.org). This can be a good place to go for questions.