interprocess_docfix/local_socket/tokio/mod.rs
1//! Asynchronous local sockets which work with the Tokio runtime and event loop.
2//!
3//! The Tokio integration allows the local 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
7mod listener;
8pub use listener::*;
9
10mod stream;
11pub use stream::*;