Metal I/O library for Rust.
Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs and event notification for building high performance I/O apps with 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.
To use mio, first add this to your Cargo.toml:
[dependencies]
mio = "1"
Next we can start using Mio. The following is a quick introduction using
TcpListener and TcpStream. Note that features = ["os-poll", "net"] must be
specified for this example.
…
The following are specifically omitted from Mio and are left to the user or higher-level libraries.
Currently supported platforms:
Mio can handle interfacing with each of the event systems of the aforementioned
platforms. The details of their implementation are further discussed in the
Poll type of the API documentation (see above).
Mio generally supports the same versions of the above mentioned platforms as Rust the language (rustc) does, unless otherwise noted.
The Windows implementation for polling sockets is using the wepoll strategy. This uses the Windows AFD system to access socket readiness events.
The MSRV (Minimum Supported Rust Version) is fixed for a given minor (1.x) version. However it can be increased when bumping minor versions, i.e. going from 1.0 to 1.1 allows us to increase the MSRV. Users unable to increase their Rust version can use an older minor version instead. Below is a list of Mio versions and their MSRV:
Note however that Mio also has dependencies, which might have different MSRV policies. We try to stick to the above policy when updating dependencies, but this is not always possible.
Mio uses different implementations to support the same functionality depending on the platform. Mio generally uses the "best" implementation possible, where "best" usually means most efficient for Mio's use case. However this means that the implementation is often specific to a limited number of platforms, meaning we often have multiple implementations for the same functionality. In some cases it might be required to not use the "best" implementation, but another implementation Mio supports (on other platforms). Mio does not officially support secondary implementations on platforms, however we do have various cfg flags to force another implementation for these situations.
Current flags:
mio_unsupported_force_poll_poll, uses an implementation based on poll(2)
for mio::Poll.mio_unsupported_force_waker_pipe, uses an implementation based on pipe(2)
for mio::Waker.Again, Mio does not officially supports this. Furthermore these flags may disappear in the future.
A group of Mio users hang out on Discord, this can be a good place to go for questions. It's also possible to open a new issue on GitHub to ask questions, report bugs or suggest new features.
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 Discord.
Finally, be kind. We support the Rust Code of Conduct.
No open issues yet, or sync has not completed.