Skip to content

Commit

Permalink
Start the index and topic index
Browse files Browse the repository at this point in the history
  • Loading branch information
nrc committed Nov 24, 2024
1 parent 7903cc4 commit 676dce7
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
76 changes: 76 additions & 0 deletions src/navigation/index.md
Original file line number Diff line number Diff line change
@@ -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`
7 changes: 7 additions & 0 deletions src/navigation/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Navigation

TODO Intro to navigation

- [By topic](topics.md)
- [FAQs]()
- [Index](index.md)
20 changes: 20 additions & 0 deletions src/navigation/topics.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 676dce7

Please sign in to comment.