Skip to content

Commit

Permalink
Fix references (part 3)
Browse files Browse the repository at this point in the history
  • Loading branch information
john-cd committed Oct 11, 2024
1 parent 59a9777 commit f0ed42f
Show file tree
Hide file tree
Showing 30 changed files with 65 additions and 62 deletions.
2 changes: 1 addition & 1 deletion src/categories/asynchronous/futures.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{{#include futures.incl.md}}

[![futures][c-futures-badge]][c-futures] [![futures-crates.io][c-futures-crate-badge]][c-futures-crates.io] [![cat-asynchronous][cat-asynchronous-badge]][cat-asynchronous]
[![futures][c-futures-badge]][c-futures] [![futures-crates.io][c-futures-crates.io-badge]][c-futures-crates.io] [![cat-asynchronous][cat-asynchronous-badge]][cat-asynchronous]

The [`{{i:futures}}`][c-futures]⮳ crate provides a number of core abstractions for writing {{i:asynchronous code}}.

Expand Down
8 changes: 4 additions & 4 deletions src/categories/asynchronous/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ In most cases, prefer the [`{{i:Tokio}}`](tokio.md) {{i:runtime}} - see [The Sta

Alternatives to the Tokio async ecosystem include:

- [![async-std][c-async-std-badge]][async-std] [async-std][async-std-crates.io]⮳: async version of the Rust standard library. No longer maintained?
- [![smol][c-smol-badge]][c-smol] [Smol][smol-crates.io]
- [![embassy][c-embassy-badge]][c-embassy] [Embassy][embassy-website][![embassy-github][c-embassy-github-badge]][embassy-github] for embedded systems.
- [![mio][c-mio-badge]][c-mio] [Mio][mio-crates.io]⮳ is a fast, low-level I/O library for Rust focusing on non-blocking APIs and event notification for building high performance I/O apps with as little overhead as possible over the OS abstractions. It is part of the Tokio ecosystem.
- [![async-std][c-async-std-badge]][c-async-std] [async-std][c-async-std-crates.io]⮳: async version of the Rust standard library. No longer maintained?
- [![smol][c-smol-badge]][c-smol] [Smol][c-smol-crates.io]
- [![embassy][c-embassy-badge]][c-embassy] [Embassy][c-embassy-website][![embassy-github][c-embassy-github-badge]][c-embassy-github] for embedded systems.
- [![mio][c-mio-badge]][c-mio] [Mio][c-mio-crates.io]⮳ is a fast, low-level I/O library for Rust focusing on non-blocking APIs and event notification for building high performance I/O apps with as little overhead as possible over the OS abstractions. It is part of the Tokio ecosystem.

{{#include refs.incl.md}}
{{#include ../../refs/link-refs.md}}
2 changes: 1 addition & 1 deletion src/categories/command-line-interface/ansi_terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This program depicts the use of [`{{i:ansi_term}}`][c-ansi-term-crates.io]⮳ crate and how it is used for controlling colours and formatting, such as blue bold text or yellow underlined text, on {{i:ANSI terminals}}.

There are two main data structures in [`{{i:ansi_term}}`][c-ansi-term-crates.io]⮳: [`{{i:ANSIString}}`][c-ansi_term::ANSIString]⮳ and [`{{i:Style}}`][ansi_term:Style]⮳. A `{{i:Style}}` holds stylistic information: colors, whether the text should be bold, or blinking, or whatever. There are also Colour variants that represent simple foreground colour styles. An [`{{i:ANSIString}}`][c-ansi_term::ANSIString]⮳ is a string paired with a [`{{i:Style}}`][c-ansi_term::Style]⮳.
There are two main data structures in [`{{i:ansi_term}}`][c-ansi-term-crates.io]⮳: [`{{i:ANSIString}}`][c-ansi_term::ANSIString]⮳ and [`{{i:Style}}`][c-ansi_term:Style]⮳. A `{{i:Style}}` holds stylistic information: colors, whether the text should be bold, or blinking, or whatever. There are also Colour variants that represent simple foreground colour styles. An [`{{i:ANSIString}}`][c-ansi_term::ANSIString]⮳ is a string paired with a [`{{i:Style}}`][c-ansi_term::Style]⮳.

**Note:** British English uses *Colour* instead of *Color*.

Expand Down
4 changes: 2 additions & 2 deletions src/categories/command-line-interface/arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

## Using clap's builder API

[![clap][c-clap-badge]][c-clap] [![clap-examples][clap-examples-badge]][clap-examples] [![clap-github][clap-github-badge]][clap-github] [![cat-command-line-interface][cat-command-line-interface-badge]][cat-command-line-interface]
[![clap][c-clap-badge]][c-clap] [![clap-examples][c-clap-examples-badge]][c-clap-examples] [![clap-github][c-clap-github-badge]][c-clap-github] [![cat-command-line-interface][cat-command-line-interface-badge]][cat-command-line-interface]

This application describes the structure of its command-line interface using [`{{i:clap}}`][c-clap]⮳'s builder style. The [documentation][c-clap]⮳ gives two other possible ways to instantiate an application.

In the builder style, `with_name` is the unique identifier that `value_of` will use to retrieve the value passed. The [`{{i:short}}`][clap::Arg::short]⮳ and [`{{i:long}}`][clap::Arg::long]⮳ options control the {{i:flag}} the user will be expected to type; short flags look like `-f` and long flags look like `--file`.
In the builder style, `with_name` is the unique identifier that `value_of` will use to retrieve the value passed. The [`{{i:short}}`][c-clap::Arg::short]⮳ and [`{{i:long}}`][c-clap::Arg::long]⮳ options control the {{i:flag}} the user will be expected to type; short flags look like `-f` and long flags look like `--file`.

```rust,editable
{{#include ../../../deps/tests/clap-basic.rs}}
Expand Down
2 changes: 1 addition & 1 deletion src/categories/command-line-interface/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Techniques to help create {{i:command line interfaces}}, such as {{i:argument pa

[![tui-rs][c-tui-rs-badge]][c-tui-rs]

[![r3bl-tuify][c-r3bl-tuify-badge]][c-r3bl-tuify] [![r3bl_tuify-crates.io][c-r3bl_tuify-crate-badge]][c-r3bl_tuify-crates.io][![blog-tuify][c-tuify-blog-badge]][blog-tuify]
[![r3bl-tuify][c-r3bl-tuify-badge]][c-r3bl-tuify] [![r3bl_tuify-crates.io][c-r3bl_tuify-crates.io-badge]][c-r3bl_tuify-crates.io][![blog-tuify][blog-tuify-badge]][blog-tuify]

{{#include refs.incl.md}}
{{#include ../../refs/link-refs.md}}
4 changes: 2 additions & 2 deletions src/categories/command-line-utilities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[My terminal became more Rusty Community][blog-rusty-terminal]

[![open-rs-github][c-open-rs-github-badge]][open-rs-github]
[![open-rs-github][c-open-rs-github-badge]][c-open-rs-github]

[![starship-github][c-starship-github-badge]][c-starship-github]

Expand Down Expand Up @@ -41,7 +41,7 @@ apt install lsd

## `gping`

Ping, but with a graph [`{{i:gping}}`][c-gping]
Ping, but with a graph [`{{i:gping}}`][c-gping-github]

```sh
apt install gping
Expand Down
2 changes: 1 addition & 1 deletion src/categories/compilers/cross_compilation.incl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
| Recipe | Crates | Categories |
|---|---|---|
| [Cross][ex-cross] | [![cross-github][cross-github-badge]][cross-github] | [![cat-compilers][cat-compilers-badge]][cat-compilers] |
| [Cross][ex-cross] | [![cross-github][c-cross-github-badge]][c-cross-github] | [![cat-compilers][cat-compilers-badge]][cat-compilers] |
4 changes: 2 additions & 2 deletions src/categories/compilers/cross_compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

## Cross

[![cross-github][cross-github-badge]][cross-github] [![cat-compilers][cat-compilers-badge]][cat-compilers]
[![cross-github][c-cross-github-badge]][c-cross-github] [![cat-compilers][cat-compilers-badge]][cat-compilers]

[`{{i:cross}}`][cross-github]⮳ builds your Rust project for different target operating systems and architectures. It requires [`{{i:rustup}}`][rustup-website]⮳ and [`{{i:Docker}}`][c-docker]⮳ or [`{{i:Podman}}`][podman-website]⮳.
[`{{i:cross}}`][c-cross-github]⮳ builds your Rust project for different target operating systems and architectures. It requires [`{{i:rustup}}`][rustup-website]⮳ and [`{{i:Docker}}`][docker-website]⮳ or [`{{i:Podman}}`][podman-website]⮳.

```sh
cargo install cross --git https://github.com/cross-rs/cross
Expand Down
4 changes: 2 additions & 2 deletions src/categories/concurrency/message_passing.incl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
| [Create a parallel data pipeline][ex-crossbeam-pipeline] | [![crossbeam][c-crossbeam-badge]][c-crossbeam] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Pass data between two threads][ex-crossbeam-spsc] | [![crossbeam][c-crossbeam-badge]][c-crossbeam] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Maintain global mutable state][ex-global-mut-state] | [![lazy-static][c-lazy-static-badge]][c-lazy-static] | [![cat-rust-patterns][cat-rust-patterns-badge]][cat-rust-patterns] |
| [Calculate SHA1 sum of *.iso files concurrently][ex-threadpool-walk] | [![threadpool][c-threadpool-badge]][c-threadpool] [![walkdir][c-walkdir-badge]][c-walkdir] [![num-cpus][c-num-cpus-badge]][num-cpus] [![ring][c-ring-badge]][c-ring] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] [![cat-filesystem][cat-filesystem-badge]][cat-filesystem] |
| [Draw fractal dispatching work to a thread pool][ex-threadpool-fractal] | [![threadpool][c-threadpool-badge]][c-threadpool] [![num][c-num-badge]][c-num] [![num-cpus][c-num-cpus-badge]][num-cpus] [![image][c-image-badge]][c-image] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency][![cat-science][cat-science-badge]][cat-science][![cat-rendering][cat-rendering-badge]][cat-rendering] |
| [Calculate SHA1 sum of *.iso files concurrently][ex-threadpool-walk] | [![threadpool][c-threadpool-badge]][c-threadpool] [![walkdir][c-walkdir-badge]][c-walkdir] [![num-cpus][c-num-cpus-badge]][c-num-cpus] [![ring][c-ring-badge]][c-ring] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] [![cat-filesystem][cat-filesystem-badge]][cat-filesystem] |
| [Draw fractal dispatching work to a thread pool][ex-threadpool-fractal] | [![threadpool][c-threadpool-badge]][c-threadpool] [![num][c-num-badge]][c-num] [![num-cpus][c-num-cpus-badge]][c-num-cpus] [![image][c-image-badge]][c-image] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency][![cat-science][cat-science-badge]][cat-science][![cat-rendering][cat-rendering-badge]][cat-rendering] |
| [Mutate the elements of an array in parallel][ex-rayon-iter-mut] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Test in parallel if any or all elements of a collection match a given predicate][ex-rayon-any-all] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Search items using given predicate in parallel][ex-rayon-parallel-search] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
Expand Down
2 changes: 1 addition & 1 deletion src/categories/concurrency/message_passing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Message passing in [`{{i:async}}`][book-rust-reference-async]⮳ programming is

## Crossbeam_channel

[![crossbeam-channel][crossbeam-channel-badge]][crossbeam-channel] [![cat-concurrency][cat-concurrency-badge]][cat-concurrency]
[![crossbeam-channel][c-crossbeam-channel-badge]][c-crossbeam-channel] [![cat-concurrency][cat-concurrency-badge]][cat-concurrency]

Multi-producer {{i:multi-consumer channels}} for message passing.

Expand Down
4 changes: 2 additions & 2 deletions src/categories/concurrency/multithreading.incl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
| [Create a parallel data pipeline][ex-crossbeam-pipeline] | [![crossbeam][c-crossbeam-badge]][c-crossbeam] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Pass data between two threads][ex-crossbeam-spsc] | [![crossbeam][c-crossbeam-badge]][c-crossbeam] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Maintain global mutable state][ex-global-mut-state] | [![lazy-static][c-lazy-static-badge]][c-lazy-static] | [![cat-rust-patterns][cat-rust-patterns-badge]][cat-rust-patterns] |
| [Calculate SHA1 sum of *.iso files concurrently][ex-threadpool-walk] | [![threadpool][c-threadpool-badge]][c-threadpool] [![walkdir][c-walkdir-badge]][c-walkdir] [![num-cpus][c-num-cpus-badge]][num-cpus] [![ring][c-ring-badge]][c-ring] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] [![cat-filesystem][cat-filesystem-badge]][cat-filesystem] |
| [Draw fractal dispatching work to a thread pool][ex-threadpool-fractal] | [![threadpool][c-threadpool-badge]][c-threadpool] [![num][c-num-badge]][c-num] [![num-cpus][c-num-cpus-badge]][num-cpus] [![image][c-image-badge]][c-image] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency][![cat-science][cat-science-badge]][cat-science][![cat-rendering][cat-rendering-badge]][cat-rendering] |
| [Calculate SHA1 sum of *.iso files concurrently][ex-threadpool-walk] | [![threadpool][c-threadpool-badge]][c-threadpool] [![walkdir][c-walkdir-badge]][c-walkdir] [![num-cpus][c-num-cpus-badge]][c-num-cpus] [![ring][c-ring-badge]][c-ring] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] [![cat-filesystem][cat-filesystem-badge]][cat-filesystem] |
| [Draw fractal dispatching work to a thread pool][ex-threadpool-fractal] | [![threadpool][c-threadpool-badge]][c-threadpool] [![num][c-num-badge]][c-num] [![num-cpus][c-num-cpus-badge]][c-num-cpus] [![image][c-image-badge]][c-image] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency][![cat-science][cat-science-badge]][cat-science][![cat-rendering][cat-rendering-badge]][cat-rendering] |
| [Mutate the elements of an array in parallel][ex-rayon-iter-mut] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Test in parallel if any or all elements of a collection match a given predicate][ex-rayon-any-all] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Search items using given predicate in parallel][ex-rayon-parallel-search] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
Expand Down
2 changes: 1 addition & 1 deletion src/categories/concurrency/shared_state/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Allow access to data from one thread at a time.

## Parking Lot

[![parking-lot][c-parking-lot-badge]][c-parking-lot] [![parking-lot-crates.io][c-parking-lot-crate-badge]][c-parking-lot-crates.io] [![cat-concurrency][cat-concurrency-badge]][cat-concurrency]
[![parking-lot][c-parking-lot-badge]][c-parking-lot] [![parking-lot-crates.io][c-parking-lot-crates.io-badge]][c-parking-lot-crates.io] [![cat-concurrency][cat-concurrency-badge]][cat-concurrency]

[`{{i:Parking Lot}}`][c-parking-lot]⮳ provides implementations of [`{{i:Mutex}}`][c-parking_lot::Mutex]⮳, [`{{i:RwLock}}`][c-parking_lot::RwLock]⮳, [`{{i:Condvar}}`][c-parking_lot::Condvar]⮳ and [`{{i:Once}}`][c-parking_lot::Once]⮳ that are smaller, faster and more flexible than those in the Rust standard library. It also provides a [`{{i:ReentrantMutex}}`][c-parking_lot::ReentrantMutex]⮳ type.

Expand Down
4 changes: 2 additions & 2 deletions src/categories/concurrency/threads.incl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
| [Create a parallel data pipeline][ex-crossbeam-pipeline] | [![crossbeam][c-crossbeam-badge]][c-crossbeam] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Pass data between two threads][ex-crossbeam-spsc] | [![crossbeam][c-crossbeam-badge]][c-crossbeam] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Maintain global mutable state][ex-global-mut-state] | [![lazy-static][c-lazy-static-badge]][c-lazy-static] | [![cat-rust-patterns][cat-rust-patterns-badge]][cat-rust-patterns] |
| [Calculate SHA1 sum of *.iso files concurrently][ex-threadpool-walk] | [![threadpool][c-threadpool-badge]][c-threadpool] [![walkdir][c-walkdir-badge]][c-walkdir] [![num-cpus][c-num-cpus-badge]][num-cpus] [![ring][c-ring-badge]][c-ring] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] [![cat-filesystem][cat-filesystem-badge]][cat-filesystem] |
| [Draw fractal dispatching work to a thread pool][ex-threadpool-fractal] | [![threadpool][c-threadpool-badge]][c-threadpool] [![num][c-num-badge]][c-num] [![num-cpus][c-num-cpus-badge]][num-cpus] [![image][c-image-badge]][c-image] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency][![cat-science][cat-science-badge]][cat-science][![cat-rendering][cat-rendering-badge]][cat-rendering] |
| [Calculate SHA1 sum of *.iso files concurrently][ex-threadpool-walk] | [![threadpool][c-threadpool-badge]][c-threadpool] [![walkdir][c-walkdir-badge]][c-walkdir] [![num-cpus][c-num-cpus-badge]][c-num-cpus] [![ring][c-ring-badge]][c-ring] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] [![cat-filesystem][cat-filesystem-badge]][cat-filesystem] |
| [Draw fractal dispatching work to a thread pool][ex-threadpool-fractal] | [![threadpool][c-threadpool-badge]][c-threadpool] [![num][c-num-badge]][c-num] [![num-cpus][c-num-cpus-badge]][c-num-cpus] [![image][c-image-badge]][c-image] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency][![cat-science][cat-science-badge]][cat-science][![cat-rendering][cat-rendering-badge]][cat-rendering] |
| [Mutate the elements of an array in parallel][ex-rayon-iter-mut] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Test in parallel if any or all elements of a collection match a given predicate][ex-rayon-any-all] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
| [Search items using given predicate in parallel][ex-rayon-parallel-search] | [![rayon][c-rayon-badge]][c-rayon] | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
Expand Down
Loading

0 comments on commit f0ed42f

Please sign in to comment.