rust
/
smol
mirror of https://github.com/stjepang/smol
1
0
Fork 0
Code Issues Releases Wiki Activity

More docs

This commit is contained in:
Stjepan Glavina 2020-08-30 22:32:10 +02:00
parent 440c29e531
commit 1ab67fba35
2 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -13,6 +13,11 @@ https://discord.gg/x6m5Vvt)
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:
@ -33,12 +38,9 @@ fn main() -> io::Result<()> {
}
```
This example uses the `net` module for networking, but you can also use the primitive
`Async` type. See the [full code][get-request].
There's a lot more in the [examples] directory.
Look inside the [examples] directory for more.
[`async-net`]: https://docs.rs/async-net
[`async-compat`]: https://docs.rs/async-compat
[examples]: https://github.com/stjepang/smol/tree/master/examples
[get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs

12
src/lib.rs
View File

@ -1,5 +1,10 @@
//! 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:
@ -20,12 +25,9 @@
//! }
//! ```
//!
//! This example uses the [`net`] module for networking, but you can also use the primitive
//! [`Async`] type. See the [full code][get-request].
//! There's a lot more in the [examples] directory.
//!
//! Look inside the [examples] directory for more.
//!
//! [`async-net`]: https://docs.rs/async-net
//! [`async-compat`]: https://docs.rs/async-compat
//! [examples]: https://github.com/stjepang/smol/tree/master/examples
//! [get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs