Merge branch 'master' into catch_panic_anti_pattern

Author: simonsan

.github/workflows/url-check-config.json

@@ -0,0 +1,7 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^(http|https)://crates.io/"
+    }
+  ]
+}

.github/workflows/url-check-on-change.yml

@@ -0,0 +1,18 @@
+name: Check Markdown links
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-verbose-mode: 'yes'
+        use-quiet-mode: 'yes'
+        config-file: '.github/workflows/url-check-config.json'
+        check-modified-files-only: 'yes'

.github/workflows/url-check-periodic.yml

@@ -0,0 +1,17 @@
+name: Check Markdown links Periodically
+
+on:
+  schedule:
+  # Run everyday at 0:00 AM
+  - cron: "0 0 * * *"
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-verbose-mode: 'yes'
+        use-quiet-mode: 'yes'
+        config-file: '.github/workflows/url-check-config.json'

CONTRIBUTING.md

@@ -1,11 +1,10 @@
 # Contributing
 
-## Discssion board
+## Discussion board
 
 If you have a question or an idea regarding certain content but you want to have feedback of fellow community members 
 and you think it may not be appropriate to file an issue open a discussion in our [discussion board](https://github.com/rust-unofficial/patterns/discussions).
 
-
 ## Writing a new article
 
 Before writing a new article please check our [issues](https://github.com/rust-unofficial/patterns/issues) and 
@@ -29,9 +28,7 @@ with the [Wayback Machine](https://web.archive.org/) and use the link to that sn
 
 Don't forget to add your new article to the `SUMMARY.md` to let it be rendered to the book.
 
-Please make `Draft Pull requests` early so we can follow your progress and can give early feedback (see the following section). 
-
-
+Please make `Draft Pull requests` early so we can follow your progress and can give early feedback (see the following section).
 
 ## Creating a Pull Request
 
@@ -42,6 +39,11 @@ Early reviews of the community are not meant as an offense but to give feedback.
 
 A good principle: "Work together, share ideas, teach others."
 
+### Test the book locally before submitting
+
+Before submitting the PR launch the commands `mdbook build` to make sure that the book builds and `mdbook test` to make sure that
+code examples are correct.
+
 ### Important Note
 
 Please **don't force push** your branch to keep commit history and make it easier of us to see changes between reviews.

README.md

@@ -4,46 +4,24 @@ An open source book about design patterns and idioms in the Rust programming
 language that you can read [here](https://rust-unofficial.github.io/patterns/).
 
 
-## Contents
-
-[Introduction](intro.md)
-
+## TODOs
 
 ### Idioms
 
-* [Constructor](idioms/ctor.md)
-* [Concatenating strings with `format!`](idioms/concat-format.md)
-* [Privacy for extensibility](idioms/priv-extend.md)
 * TODO stability for extensibility
 * TODO trait to separate visibility of methods from visibility of data (https://github.com/sfackler/rust-postgres/blob/v0.9.6/src/lib.rs#L1400)
-* [Collections are smart pointers](idioms/deref.md)
 * TODO leak amplification ("Vec::drain sets the Vec's len to 0 prematurely so that mem::forgetting Drain "only" mem::forgets more stuff. instead of exposing uninitialized memory or having to update the len on every iteration")
-* [Finalisation in destructors](idioms/dtor-finally.md)
 * TODO interior mutability - UnsafeCell, Cell, RefCell
-* [Iterating over an `Option`](idioms/option-iter.md)
-* [`Default` trait](idioms/default.md)
-* [Pass variables to closure](idioms/pass-var-to-closure.md)
-* [`mem::replace(_)` to avoid needless clones](idioms/mem-replace.md)
-* [Temporary mutability](idioms/temporary-mutability.md)
-* [On-Stack Dynamic Dispatch](idioms/on-stack-dyn-dispatch.md)
 * TODO FFI usage (By being mindful of how to provide Rust libraries, and make use of existing libraries across the FFI, you can get more out of benefits Rust can bring)
-* [Easy doc initialization](idioms/rustdoc-init.md)
 
 
 ### Design patterns
 
-* [Builder](patterns/builder.md)
-* [RAII guards](patterns/RAII.md)
-* [Newtype](patterns/newtype.md)
 * TODO iterators (to safely avoid bounds checks)
 * TODO closures and lifetimes (coupling to lifetime)
 * TODO platform-specific sub-modules (https://github.com/rust-lang/rfcs/blob/master/text/0517-io-os-reform.md#platform-specific-opt-in)
 * TODO Module organisation (by looking at examples such as Rusts `libstd`, and how it integrated into the Rusts source code, lessons can be learned about ergonomic project management and API design. Closely assosciated with platform-specific sub-modules)
-* [Entry API](patterns/entry.md) (TODO Currently just a boilerplate)
-* [Visitor](patterns/visitor.md)
-* [Fold](patterns/fold.md)
-* [Prefer small crates](patterns/small-crates.md)
-* [Contain unsafety in small modules](patterns/unsafe-mods.md)
+* [Entry API](patterns/entry.md) (Currently just a boilerplate)
 * TODO extension traits
 * TODO destructor bombs (ensure linear typing dynamically, e.g., https://github.com/Munksgaard/session-types/commit/0f25ccb7c3bc9f65fa8eaf538233e8fe344a189a)
 * TODO convertible to Foo trait for more generic generics (e.g., http://static.rust-lang.org/doc/master/std/fs/struct.File.html#method.open)
@@ -52,19 +30,16 @@ language that you can read [here](https://rust-unofficial.github.io/patterns/).
 * TODO composition of structs to please the borrow checker
 * TODO `Error` traits and `Result` forwarding
 * TODO graphs
-* [Compose structs together for better borrowing](patterns/compose-structs.md)
 
 
 ### Anti-patterns
 
 * [catch_unwind for exceptions](anti_patterns/catch_panic.md)
 * TODO Clone to satisfy the borrow checker
-* [Deref polymorphism](anti_patterns/deref.md)
 * TODO Matching all fields of a struct (back compat)
 * TODO wildcard matches
 * TODO taking an enum rather than having multiple functions
 * TODO `unwrap()`ing every `Result` instead of forwarding it
-* [`#[deny(warnings)]`](anti_patterns/deny-warnings.md)
 
 
 ## Contributing

SUMMARY.md

@@ -2,7 +2,7 @@
 
 - [Introduction](./intro.md)
 
-- [Idioms](./idioms/README.md)
+- [Idioms](./idioms/index.md)
     - [Concatenating Strings with `format!`](./idioms/concat-format.md)
     - [Constructor](./idioms/ctor.md)
     - [The `Default` Trait](./idioms/default.md)
@@ -16,22 +16,21 @@
     - [Easy doc initialization](./idioms/rustdoc-init.md)
     - [Temporary mutability](./idioms/temporary-mutability.md)
 
-- [Design Patterns](./patterns/README.md)
+- [Design Patterns](./patterns/index.md)
     - [Builder](./patterns/builder.md)
     - [Compose Structs](./patterns/compose-structs.md)
     - [Fold](./patterns/fold.md)
-    - [Late Bound Bounds](./patterns/late-bounds.md)
     - [Newtype](./patterns/newtype.md)
     - [RAII Guards](./patterns/RAII.md)
     - [Prefer Small Crates](./patterns/small-crates.md)
     - [Contain unsafety in small modules](./patterns/unsafe-mods.md)
     - [Visitor](./patterns/visitor.md)
 
-- [Anti-patterns](./anti_patterns/README.md)
+- [Anti-patterns](./anti_patterns/index.md)
     - [catch_unwind for exceptions](./anti_patterns/catch_panic.md)
     - [`#[deny(warnings)]`](./anti_patterns/deny-warnings.md)
     - [Deref Polymorphism](./anti_patterns/deref.md)
 
-- [Functional Programming](./functional/README.md)
+- [Functional Programming](./functional/index.md)
 
 - [Additional Resources](./additional_resources.md)

anti_patterns/README.md renamed to anti_patterns/index.md

@@ -15,17 +15,17 @@ println!("{}", sum);
 With imperative programs, we have to play compiler to see what is happening. Here, we start with a `sum` of `0`. Next, we iterate through the range from 1 to 10. Each time through the loop, we add the corresponding value in the range. Then we print it out.
 
 | `i` | `sum` |
-| --- | ----- |
-| 1   | 1     |
-| 2   | 3     |
-| 3   | 6     |
-| 4   | 10    |
-| 5   | 15    |
-| 6   | 21    |
-| 7   | 28    |
-| 8   | 36    |
-| 9   | 45    |
-| 10  | 55    |
+|:---:|:-----:|
+|   1 |     1 |
+|   2 |     3 |
+|   3 |     6 |
+|   4 |    10 |
+|   5 |    15 |
+|   6 |    21 |
+|   7 |    28 |
+|   8 |    36 |
+|   9 |    45 |
+|  10 |    55 |
 
 This is how most of us start out programming. We learn that a program is a set of steps.
 
@@ -40,14 +40,14 @@ Whoa! This is really different! What's going on here? Remember that with declara
 Here, we are composing functions of addition (this closure: `|a, b| a + b)`) with a range from 1 to 10. The `0` is the starting point, so `a` is `0` at first. `b` is the first element of the range, `1`. `0 + 1 = 1` is the result. So now we `fold` again, with `a = 1`, `b = 2` and so `1 + 2 = 3` is the next result. This process continues until we get to the last element in the range, `10`.
 
 | `a` | `b` | result |
-| --- | --- | ------ |
-| 0   | 1   | 1      |
-| 1   | 2   | 3      |
-| 3   | 3   | 6      |
-| 6   | 4   | 10     |
-| 10  | 5   | 15     |
-| 15  | 6   | 21     |
-| 21  | 7   | 28     |
-| 28  | 8   | 36     |
-| 36  | 9   | 45     |
-| 45  | 10  | 55     |
+|:---:|:---:|:------:|
+|   0 |   1 |      1 |
+|   1 |   2 |      3 |
+|   3 |   3 |      6 |
+|   6 |   4 |     10 |
+|  10 |   5 |     15 |
+|  15 |   6 |     21 |
+|  21 |   7 |     28 |
+|  28 |   8 |     36 |
+|  36 |   9 |     45 |
+|  45 |  10 |     55 |

functional/README.md renamed to functional/index.md

@@ -19,14 +19,16 @@ different names, but there can only be one `Default` implementation per type.
 
 ## Example
 
-```rust,ignore
+```rust
+use std::{path::PathBuf, time::Duration};
+
 // note that we can simply auto-derive Default here.
-#[derive(Default)]
+#[derive(Default, Debug)]
 struct MyConfiguration {
     // Option defaults to None
-    output: Option<Path>,
+    output: Option<PathBuf>,
     // Vecs default to empty vector
-    search_path: Vec<Path>,
+    search_path: Vec<PathBuf>,
     // Duration defaults to zero time
     timeout: Duration,
     // bool defaults to false
@@ -40,7 +42,9 @@ impl MyConfiguration {
 fn main() {
     // construct a new instance with default values
     let mut conf = MyConfiguration::default();
-    // do somthing with conf here
+    // do something with conf here
+    conf.check = true;
+    println!("conf = {:#?}", conf);
 }
 ```
 

idioms/default.md

@@ -76,7 +76,7 @@ The finaliser must be assigned into a variable, otherwise it will be destroyed
 immediately, rather than when it goes out of scope. The variable name must start
 with `_` if the variable is only used as a finaliser, otherwise the compiler
 will warn that the finaliser is never used. However, do not call the variable
-`_` with no suffix - in that case it will be again be destroyed immediately.
+`_` with no suffix - in that case it will be destroyed immediately.
 
 In Rust, destructors are run when an object goes out of scope. This happens
 whether we reach the end of block, there is an early return, or the program