Skip to content

Commit 13ee7b6

Browse files
committed
Add two chapters as TODO and change intro
1 parent 9ae2742 commit 13ee7b6

File tree

6 files changed

+21
-15
lines changed

6 files changed

+21
-15
lines changed

docs/src/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Summary
22

3-
- [Welcome to `async-std`!](./overview.md)
4-
- [`async-std`](./overview/async-std.md)
3+
- [Introduction](./introduction.md)
4+
- [Welcome to `async-std`!](./overview/async-std.md)
55
- [`std::future` and `futures-rs`](./overview/std-and-library-futures.md)
66
- [Stability guarantees](./overview/stability-guarantees.md)
77
- [Async concepts using async-std](./concepts.md)

docs/src/concepts/async-read-write.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Async read/write
1+
# TODO: Async read/write

docs/src/concepts/streams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Streams
1+
# TODO: Streams

docs/src/introduction.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Introduction
2+
3+
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.
4+
5+
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.
6+
7+
[async-book]: https://rust-lang.github.io/async-book/

docs/src/overview.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/src/overview/async-std.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
# async-std
1+
# Welcome to `async-std`
2+
3+
![async-std logo](./images/horizontal_color.svg)
4+
5+
`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.
6+
7+
`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].
8+
9+
[organization]: https://github.com/async-rs/async-std
10+
[overview-std]: overview/async-std/

0 commit comments

Comments
 (0)