Crate smol

source ·
Expand description

A small and fast async runtime.

This crate simply re-exports other smaller async crates (see the source).

To use tokio-based libraries with smol, apply the async-compat adapter to futures and I/O types.

See the smol-macros crate if you want a no proc-macro, fast compiling, easy-to-use async main and/or multi-threaded Executor setup out of the box.

§Examples

Connect to an HTTP website, make a GET request, and pipe the response to the standard output:

use smol::{io, net, prelude::*, Unblock};

fn main() -> io::Result<()> {
    smol::block_on(async {
        let mut stream = net::TcpStream::connect("example.com:80").await?;
        let req = b"GET / HTTP/1.1\r\nHost: example.com\r\nConnection: close\r\n\r\n";
        stream.write_all(req).await?;

        let mut stdout = Unblock::new(std::io::stdout());
        io::copy(stream, &mut stdout).await?;
        Ok(())
    })
}

There’s a lot more in the examples directory.

Modules§

Macros§

  • Pins a variable of type T on the stack and rebinds it as Pin<&mut T>.
  • Unwraps Poll<T> or returns Pending.

Structs§

Functions§

  • Blocks the current thread on a future, processing I/O events when idle.
  • Spawns a task onto the global executor (single-threaded by default).
  • Runs blocking code on a thread pool.