Go to file
John Nunley 2e3dfc7975 docs: Mention that drop() is not called for statically spawned tasks
Signed-off-by: John Nunley <dev@notgull.net>
2024-06-09 16:41:57 -07:00
.github Update actions/checkout action to v4 2023-09-10 18:28:30 +09:00
assets/images docs: Use the new smol logo in docs and README 2023-07-16 07:22:16 -07:00
examples ex: Use smol-hyper in hyper-server example 2024-01-15 17:54:46 -08:00
src docs: Mention that drop() is not called for statically spawned tasks 2024-06-09 16:41:57 -07:00
.gitignore
CHANGELOG.md v2.0.0 2023-12-31 10:42:28 -08:00
CODE_OF_CONDUCT.md
Cargo.toml Update async-tungstenite requirement from 0.25 to 0.26 2024-06-03 22:54:10 +09:00
LICENSE-APACHE
LICENSE-MIT
README.md docs: Add link to Matrix chat to README 2024-01-15 17:40:30 -08:00

README.md

smol

Build License Cargo Documentation Chat

kitty

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.

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.

Subcrates

TLS certificate

Some code examples are using TLS for authentication. The repository contains a self-signed certificate usable for testing, but it should not be used for real-world scenarios. Browsers and tools like curl will show this certificate as insecure.

In browsers, accept the security prompt or use curl -k on the command line to bypass security warnings.

The certificate file was generated using minica and openssl:

minica --domains localhost -ip-addresses 127.0.0.1 -ca-cert certificate.pem
openssl pkcs12 -export -out identity.pfx -inkey localhost/key.pem -in localhost/cert.pem

Another useful tool for making certificates is mkcert.

MSRV Policy

The Minimum Supported Rust Version (MSRV) of this crate is 1.63. As a tentative policy, the MSRV will not advance past the current Rust version provided by Debian Stable. At the time of writing, this version of Rust is 1.63. However, the MSRV may be advanced further in the event of a major ecosystem shift or a security vulnerability.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.