futures_net/driver/sys/mod.rs
1#![allow(missing_docsbare_trait_objects, deprecated, unknown_lints)]
2#![deny(missing_debug_implementations)]
3
4//! Linux systrem-io api.
5//!
6//! # Features
7//!
8//! * Non-blocking TCP, UDP
9//! * I/O event notification queue backed by epoll
10//! * Zero allocations at runtime
11//! * Platform specific extensions
12//!
13//! handle interfacing with each of the event notification systems of the aforementioned platforms. The details of
14//! their implementation are further discussed in [`Poll`].
15//!
16//! # Usage
17//!
18//! Creating a [`Poll`], which reads events from the OS and
19//! put them into [`Events`]. You can handle IO events from the OS with it.
20//!
21//! For more detail, see [`Poll`].
22//!
23//! [`Poll`]: struct.Poll.html
24//! [`Events`]: struct.Events.html
25
26pub mod event;
27pub mod net;
28
29mod linux;
30mod poll;
31mod token;
32
33pub use self::linux::UnixReady;
34pub use self::poll::{Poll, Registration, SetReadiness};
35pub use self::token::Token;