From 676dce7fbc5152ee7a48076d3ff4adc868f40edc Mon Sep 17 00:00:00 2001 From: Nick Cameron Date: Fri, 15 Nov 2024 14:34:50 +1300 Subject: [PATCH] Start the index and topic index --- src/SUMMARY.md | 6 ++-- src/navigation/index.md | 76 ++++++++++++++++++++++++++++++++++++++++ src/navigation/intro.md | 7 ++++ src/navigation/topics.md | 20 +++++++++++ 4 files changed, 106 insertions(+), 3 deletions(-) create mode 100644 src/navigation/index.md create mode 100644 src/navigation/intro.md create mode 100644 src/navigation/topics.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 4adfb8bb..9ae0837f 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,10 +2,10 @@ [Introduction](intro.md) -- [Navigation]() - - [By topic]() +- [Navigation](navigation/intro.md) + - [By topic](navigation/topics.md) - [FAQs]() - - [Index]() + - [Index](navigation/index.md) # Part 1: guide diff --git a/src/navigation/index.md b/src/navigation/index.md new file mode 100644 index 00000000..bc09a4d2 --- /dev/null +++ b/src/navigation/index.md @@ -0,0 +1,76 @@ +# Index + + + +- Async/`async` + - [blocks](../part-guide/adv-async-await.md#async-blocks) + - [closures](../part-guide/adv-async-await.md#async-closures) + - [functions](../part-guide/async-await.md#async-functions) + - [traits](../part-guide/adv-async-await.md#async-traits) + - [c.f., threads](../part-guide/concurrency.md#async-programming) +- [`await`](../part-guide/async-await.md#await) + + + +- [Blocking](../part-guide/adv-async-await.md#blocking-and-cancellation) + - [IO](../part-guide/adv-async-await.md#blocking-io) + + + +- [Cancellation](../part-guide/adv-async-await.md#cancellation) + - [`CancellationToken`](../part-guide/adv-async-await.md#cancellation) +- [Concurrency](../part-guide/concurrency.md) + - [c.f., parallelism](../part-guide/concurrency.md#concurrency-and-parallelism) + + + +- [Executor](../part-guide/async-await.md#the-runtime) + + + +- [Futures](../part-guide/async-await.md#futures-and-tasks) + - `Future` trait + + + +- IO + - [Blocking](../part-guide/adv-async-await.md#blocking-io) + + + +- [Joining tasks](../part-guide/async-await.md#joining-tasks) +- [`JoinHandle`](../part-guide/async-await.md#joinhandle) + - [`abort`](../part-guide/adv-async-await.md#cancellation) + + + +- Multitasking + - [Cooperative](../part-guide/concurrency.md#async-programming) + - [Pre-emptive](../part-guide/concurrency.md#processes-and-threads) + + + +- [Parallelism](../part-guide/concurrency.md#concurrency-and-parallelism) + - [c.f., concurrency](../part-guide/concurrency.md#concurrency-and-parallelism) + + + +- [Reactor](../part-guide/async-await.md#the-runtime) +- [Runtimes](../part-guide/async-await.md#the-runtime) + + + +- [Scheduler](../part-guide/async-await.md#the-runtime) +- [Spawning tasks](../part-guide/async-await.md#spawning-tasks) + + + +- [Tasks](../part-guide/async-await.md#futures-and-tasks) + - [Spawning](../part-guide/async-await.md#spawning-tasks) +- Testing + - [Unit tests](../part-guide/adv-async-await.md#unit-tests) +- [Threads](../part-guide/concurrency.md#processes-and-threads) +- [Tokio](../part-guide/async-await.md#the-runtime) +- Traits + - [async](../part-guide/adv-async-await.md#async-traits) + - `Future` diff --git a/src/navigation/intro.md b/src/navigation/intro.md new file mode 100644 index 00000000..b1977fa5 --- /dev/null +++ b/src/navigation/intro.md @@ -0,0 +1,7 @@ +# Navigation + +TODO Intro to navigation + +- [By topic](topics.md) +- [FAQs]() +- [Index](index.md) diff --git a/src/navigation/topics.md b/src/navigation/topics.md new file mode 100644 index 00000000..b4778e3b --- /dev/null +++ b/src/navigation/topics.md @@ -0,0 +1,20 @@ +# Topic index + +## Concurrency and parallelism + +- [Introduction](../part-guide/concurrency.md#concurrency-and-parallelism) +- [Running async tasks in parallel using `spawn`](../part-guide/async-await.md#spawning-tasks) + +## Correctness and safety + +- Cancellation + - [Introduction](../part-guide/adv-async-await.md#cancellation) + +## Performance + +- Blocking + - [Introduction](../part-guide/adv-async-await.md#blocking-and-cancellation) + +## Testing + +- [Unit test syntax](../part-guide/adv-async-await.md#unit-tests)