1a6915b145
As of bug 1708634, we have an unvendored-patched version of mio, but somehow it wasn't already on the very last version of 0.6. This brings us up to date. Differential Revision: https://phabricator.services.mozilla.com/D117747 |
||
|---|---|---|
| .. | ||
| src | ||
| .cargo-checksum.json | ||
| CHANGELOG.md | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
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.
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 notification 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:
- Linux
- OS X
- Windows
- FreeBSD
- NetBSD
- Solaris
- Android
- iOS
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.