The Wayback Machine - https://web.archive.org/web/20190804191055/https://github.com/tokio-rs/mio
Skip to content
Metal IO library for Rust
Rust
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Implement vectored I/O for TcpStream (#1016) Jul 16, 2019
src Split Event::is_hup into is_hup and is_read_hup and refer to OS selec… Jul 21, 2019
tests Add test for registering after de-registering (#1043) Jul 22, 2019
.cirrus.yml
.gitignore Ignore all dirs starting with target Dec 2, 2015
CHANGELOG.md Merge branch 'v0.6.x' into master May 28, 2019
Cargo.toml rewrite windows implementation (#1034) Jul 19, 2019
LICENSE Improve README and add MIT license Sep 22, 2014
README.md Remove duplicate FreeBSD listings Jul 8, 2019
azure-pipelines.yml Implement vectored I/O for TcpStream (#1016) Jul 16, 2019

README.md

Mio – Metal IO

Mio is a lightweight I/O library for Rust with a focus on adding as little overhead as possible over the OS abstractions.

Crates.io MIT licensed Build Status Build Status

API documentation

This is a low level library, if you are looking for something easier to get started with, see Tokio.

Usage

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

[dependencies]
mio = "0.6"

Then, add this to your crate root:

extern crate mio;

Features

  • Non-blocking TCP, UDP
  • I/O event queue backed by epoll, kqueue, and IOCP
  • Zero allocations at runtime
  • Platform specific extensions

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
  • Timers

Platforms

Currently supported platforms:

  • Android
  • Bitrig
  • DragonFly BSD
  • FreeBSD
  • Linux
  • NetBSD
  • OpenBSD
  • Solaris
  • Windows
  • iOS
  • macOS

There are potentially others. If you find that Mio works on another platform, submit a PR to update the list!

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.

Contributing

Interested in getting involved? We would love to help you! For simple bug fixes, just submit a PR with the fix and we can discuss the fix directly in the PR. If the fix is more complex, start with an issue.

If you want to propose an API change, create an issue to start a discussion with the community. Also, feel free to talk with us in the IRC channel.

Finally, be kind. We support the Rust Code of Conduct.

You can’t perform that action at this time.