2020-04-16 14:09:22 +00:00
|
|
|
# smol
|
|
|
|
|
2020-04-26 17:50:44 +00:00
|
|
|
[![Build](https://github.com/stjepang/smol/workflows/Build%20and%20test/badge.svg)](
|
2020-04-28 15:29:09 +00:00
|
|
|
https://github.com/stjepang/smol/actions)
|
2020-04-21 17:36:05 +00:00
|
|
|
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](
|
|
|
|
https://github.com/stjepang/smol)
|
|
|
|
[![Cargo](https://img.shields.io/crates/v/smol.svg)](
|
|
|
|
https://crates.io/crates/smol)
|
|
|
|
[![Documentation](https://docs.rs/smol/badge.svg)](
|
|
|
|
https://docs.rs/smol)
|
2020-04-27 14:06:56 +00:00
|
|
|
[![Chat](https://img.shields.io/discord/701824908866617385.svg?logo=discord)](
|
2020-04-27 10:32:50 +00:00
|
|
|
https://discord.gg/x6m5Vvt)
|
2020-04-16 14:09:22 +00:00
|
|
|
|
2020-07-23 10:24:16 +00:00
|
|
|
A small and fast async runtime.
|
2020-02-06 14:09:00 +00:00
|
|
|
|
2020-08-30 20:32:10 +00:00
|
|
|
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.
|
|
|
|
|
2020-07-23 10:24:16 +00:00
|
|
|
## Examples
|
2020-02-06 14:09:00 +00:00
|
|
|
|
2020-07-23 10:24:16 +00:00
|
|
|
Connect to an HTTP website, make a GET request, and pipe the response to the standard output:
|
2020-02-04 10:27:09 +00:00
|
|
|
|
2020-08-06 14:19:10 +00:00
|
|
|
```rust,no_run
|
2020-08-26 22:00:34 +00:00
|
|
|
use smol::{io, net, prelude::*, Unblock};
|
2020-04-21 17:36:05 +00:00
|
|
|
|
2020-07-23 10:24:16 +00:00
|
|
|
fn main() -> io::Result<()> {
|
2020-08-26 22:00:34 +00:00
|
|
|
smol::block_on(async {
|
|
|
|
let mut stream = net::TcpStream::connect("example.com:80").await?;
|
2020-07-23 10:24:16 +00:00
|
|
|
let req = b"GET / HTTP/1.1\r\nHost: example.com\r\nConnection: close\r\n\r\n";
|
|
|
|
stream.write_all(req).await?;
|
2020-05-03 16:28:19 +00:00
|
|
|
|
2020-07-23 10:24:16 +00:00
|
|
|
let mut stdout = Unblock::new(std::io::stdout());
|
|
|
|
io::copy(&stream, &mut stdout).await?;
|
|
|
|
Ok(())
|
|
|
|
})
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-08-30 20:32:10 +00:00
|
|
|
There's a lot more in the [examples] directory.
|
2020-04-21 17:36:05 +00:00
|
|
|
|
2020-08-30 20:32:10 +00:00
|
|
|
[`async-compat`]: https://docs.rs/async-compat
|
2020-07-23 10:24:16 +00:00
|
|
|
[examples]: https://github.com/stjepang/smol/tree/master/examples
|
|
|
|
[get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs
|
2020-04-21 17:36:05 +00:00
|
|
|
|
|
|
|
## TLS certificate
|
|
|
|
|
2020-04-27 23:29:30 +00:00
|
|
|
Some code examples are using TLS for authentication. The repository
|
2020-04-28 11:09:59 +00:00
|
|
|
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.
|
2020-04-21 17:36:05 +00:00
|
|
|
|
|
|
|
The certificate file was generated using
|
|
|
|
[minica](https://github.com/jsha/minica) and
|
|
|
|
[openssl](https://www.openssl.org/):
|
2020-04-20 15:45:14 +00:00
|
|
|
|
2020-08-26 22:04:00 +00:00
|
|
|
```text
|
2020-04-21 17:36:05 +00:00
|
|
|
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
|
2020-04-20 15:45:14 +00:00
|
|
|
```
|
|
|
|
|
2020-07-23 13:04:13 +00:00
|
|
|
Another useful tool for making certificates is [mkcert].
|
|
|
|
|
|
|
|
[mkcert]: https://github.com/FiloSottile/mkcert
|
|
|
|
|
2020-02-04 10:27:09 +00:00
|
|
|
## License
|
|
|
|
|
2020-04-21 17:36:05 +00:00
|
|
|
Licensed under either of
|
|
|
|
|
|
|
|
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
|
|
|
|
at your option.
|
2020-02-04 10:27:09 +00:00
|
|
|
|
2020-04-21 17:36:05 +00:00
|
|
|
#### Contribution
|
2020-02-04 10:27:09 +00:00
|
|
|
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
2020-04-21 17:36:05 +00:00
|
|
|
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.
|