From 13ee7b63c1f9e3d3560e18f57fc71138e51e212a Mon Sep 17 00:00:00 2001 From: Florian Gilcher <florian.gilcher@asquera.de> Date: Fri, 16 Aug 2019 15:34:58 +0200 Subject: [PATCH] Add two chapters as TODO and change intro --- docs/src/SUMMARY.md | 4 ++-- docs/src/concepts/async-read-write.md | 2 +- docs/src/concepts/streams.md | 2 +- docs/src/introduction.md | 7 +++++++ docs/src/overview.md | 10 ---------- docs/src/overview/async-std.md | 11 ++++++++++- 6 files changed, 21 insertions(+), 15 deletions(-) create mode 100644 docs/src/introduction.md delete mode 100644 docs/src/overview.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 9a6656e2..99b849f5 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,7 +1,7 @@ # Summary -- [Welcome to `async-std`!](./overview.md) - - [`async-std`](./overview/async-std.md) +- [Introduction](./introduction.md) + - [Welcome to `async-std`!](./overview/async-std.md) - [`std::future` and `futures-rs`](./overview/std-and-library-futures.md) - [Stability guarantees](./overview/stability-guarantees.md) - [Async concepts using async-std](./concepts.md) diff --git a/docs/src/concepts/async-read-write.md b/docs/src/concepts/async-read-write.md index 79354298..15675e99 100644 --- a/docs/src/concepts/async-read-write.md +++ b/docs/src/concepts/async-read-write.md @@ -1 +1 @@ -# Async read/write +# TODO: Async read/write diff --git a/docs/src/concepts/streams.md b/docs/src/concepts/streams.md index 80eeccb1..7f319c7c 100644 --- a/docs/src/concepts/streams.md +++ b/docs/src/concepts/streams.md @@ -1 +1 @@ -# Streams +# TODO: Streams diff --git a/docs/src/introduction.md b/docs/src/introduction.md new file mode 100644 index 00000000..2def6fcf --- /dev/null +++ b/docs/src/introduction.md @@ -0,0 +1,7 @@ +# Introduction + +This book serves as high-level documentation for `async-std` and a way of learning async programming in Rust through it. As such, i focusses on the `async-std` and its task model give you. + +Please note that the Rust project provides its own book on asynchronous programming, called ["Asynchronous Programming in Rust"][async-book], which we highly recommend reading along with this book, as it provides a different, wider view on the topic. + +[async-book]: https://rust-lang.github.io/async-book/ \ No newline at end of file diff --git a/docs/src/overview.md b/docs/src/overview.md deleted file mode 100644 index 4c659653..00000000 --- a/docs/src/overview.md +++ /dev/null @@ -1,10 +0,0 @@ -# Welcome to `async-std` - - - -`async-std` along with its [supporting libraries][organization] is a library making your life in async programming easier. It provides provide fundamental implementations for downstream libraries and applications alike. The name reflects the approach of this library: it is a closely modeled to the Rust main standard library as possible, replacing all components by async counterparts. - -`async-std` provides an interface to all important primitives: filesystem operations, network operations and concurrency basics like timers. It also exposes an `task` in a model similar to the `thread` module found in the Rust standard lib. But it does not only include io primitives, but also `async/await` compatible versions of primitives like `Mutex`. You can read more about `async-std` in [the overview chapter][overview-std]. - -[organization]: https://github.com/async-rs/async-std -[overview-std]: overview/async-std/ diff --git a/docs/src/overview/async-std.md b/docs/src/overview/async-std.md index 5b8c6ccf..4c659653 100644 --- a/docs/src/overview/async-std.md +++ b/docs/src/overview/async-std.md @@ -1 +1,10 @@ -# async-std +# Welcome to `async-std` + + + +`async-std` along with its [supporting libraries][organization] is a library making your life in async programming easier. It provides provide fundamental implementations for downstream libraries and applications alike. The name reflects the approach of this library: it is a closely modeled to the Rust main standard library as possible, replacing all components by async counterparts. + +`async-std` provides an interface to all important primitives: filesystem operations, network operations and concurrency basics like timers. It also exposes an `task` in a model similar to the `thread` module found in the Rust standard lib. But it does not only include io primitives, but also `async/await` compatible versions of primitives like `Mutex`. You can read more about `async-std` in [the overview chapter][overview-std]. + +[organization]: https://github.com/async-rs/async-std +[overview-std]: overview/async-std/