mirror of https://github.com/stjepang/smol
More docs
This commit is contained in:
parent
440c29e531
commit
1ab67fba35
12
README.md
12
README.md
|
@ -13,6 +13,11 @@ https://discord.gg/x6m5Vvt)
|
||||||
|
|
||||||
A small and fast async runtime.
|
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
|
## Examples
|
||||||
|
|
||||||
Connect to an HTTP website, make a GET request, and pipe the response to the standard output:
|
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
|
There's a lot more in the [examples] directory.
|
||||||
`Async` type. See the [full code][get-request].
|
|
||||||
|
|
||||||
Look inside the [examples] directory for more.
|
[`async-compat`]: https://docs.rs/async-compat
|
||||||
|
|
||||||
[`async-net`]: https://docs.rs/async-net
|
|
||||||
[examples]: https://github.com/stjepang/smol/tree/master/examples
|
[examples]: https://github.com/stjepang/smol/tree/master/examples
|
||||||
[get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs
|
[get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs
|
||||||
|
|
||||||
|
|
12
src/lib.rs
12
src/lib.rs
|
@ -1,5 +1,10 @@
|
||||||
//! A small and fast async runtime.
|
//! 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
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! Connect to an HTTP website, make a GET request, and pipe the response to the standard output:
|
//! 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
|
//! There's a lot more in the [examples] directory.
|
||||||
//! [`Async`] type. See the [full code][get-request].
|
|
||||||
//!
|
//!
|
||||||
//! Look inside the [examples] directory for more.
|
//! [`async-compat`]: https://docs.rs/async-compat
|
||||||
//!
|
|
||||||
//! [`async-net`]: https://docs.rs/async-net
|
|
||||||
//! [examples]: https://github.com/stjepang/smol/tree/master/examples
|
//! [examples]: https://github.com/stjepang/smol/tree/master/examples
|
||||||
//! [get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs
|
//! [get-request]: https://github.com/stjepang/smol/blob/master/examples/get-request.rs
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue