Module tokio

Asynchronous local sockets which work with the Tokio runtime and event loop.

The Tokio integration allows the local socket streams and listeners to be notified by the OS kernel whenever they’re ready to be received from of sent to, instead of spawning threads just to put them in a wait state of blocking on the I/O.

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.

Modules

prelude

Like the sync local socket prelude, but for Tokio local sockets.

Enums

Listener

Tokio-based local socket server, listening for connections.

RecvHalf

Receive half of a Tokio-based local socket stream, obtained by splitting a Stream.

SendHalf

Send half of a Tokio-based local socket stream, obtained by splitting a Stream.

Stream

Tokio-based local socket byte stream, obtained either from Listener or by connecting to an existing local socket.

Type Aliases

ReuniteError

ReuniteError for Stream.

ReuniteResult

Result type for .reunite() on Stream.