interprocess_docfix/os/unix/udsocket/tokio/mod.rs
1//! Asynchronous Ud-sockets which work with the Tokio runtime and event loop.
2//!
3//! The Tokio integration allows the Ud-socket streams and listeners to be notified by the OS kernel whenever they're ready to be read from of written to, instead of spawning threads just to put them in a wait state of blocking on the I/O.
4//!
5//! Types from this module will *not* work with other async runtimes, such as `async-std` or `smol`, since the Tokio types' methods will panic whenever they're called outside of a Tokio runtime context. Open an issue if you'd like to see other runtimes supported as well.
6
7// contains macros, has to go before the other modules
8#[macro_use]
9mod util;
10
11mod listener;
12mod socket;
13mod stream;
14pub use {listener::*, socket::*, stream::*};
15
16#[cfg(uds_supported)]
17use super::c_wrappers;