Update lib.rs, added info that needed panic messages can be found in the tests. (#157)

add cover and back to downloadable pdf

.github/workflows/ci.yml

@@ -15,16 +15,27 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          repository: mainmatter/core-sans-a-fonts
+          ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
+          path: core-sans-a-fonts
+      - name: Install Fonts
+        run: |
+          sudo cp -r core-sans-a-fonts/* /usr/local/share/fonts/
+          sudo fc-cache -f -v
+          fc-list | grep "Core Sans"
       - uses: actions-rust-lang/setup-rust-toolchain@v1
       - name: Install exercise plugin
         run: cargo install --path helpers/mdbook-exercise-linker
       - name: Install link shortener plugin
         run: cargo install --path helpers/mdbook-link-shortener
-      - name: Install mdbook-pandoc, calibre and related dependencies
+      - name: Install mdbook-pandoc, calibre, pdftk and related dependencies
         run: |
           cargo install mdbook-pandoc --locked --version 0.7.1
           sudo apt-get update
-          sudo apt-get install -y fonts-noto calibre
+          sudo apt-get install -y fonts-noto calibre pdftk
           
           export PANDOC_VERSION=3.3
           curl -LsSf https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz | tar zxf -
@@ -70,6 +81,10 @@ jobs:
         run: |
           cd book
           mdbook build
+      - name: Add cover and back to downloadable PDF
+        run: |
+          pdftk book/assets/cover.pdf book/book/pandoc/pdf/100-exercises-to-learn-rust.pdf book/assets/back.pdf cat output book/book/pandoc/pdf/100-exercises-to-learn-rust-with-cover.pdf
+          mv book/book/pandoc/pdf/100-exercises-to-learn-rust-with-cover.pdf book/book/pandoc/pdf/100-exercises-to-learn-rust.pdf
       - name: Convert HTML to ePUB
         run: |
           cd book/book/pandoc/html

book/book.toml

@@ -22,32 +22,46 @@ git-repository-url = "https://github.com/mainmatter/100-exercises-to-learn-rust"
 optional = true
 hosted-html = "https://rust-exercises.com/100-exercises/"
 
+[output.pandoc.code]
+show-hidden-lines = true
+
 [output.pandoc.profile.pdf] # options to pass to Pandoc (see https://pandoc.org/MANUAL.html)
 output-file = "100-exercises-to-learn-rust.pdf"
 to = "latex"
-highlight-style = "tango"
+highlight-style = "./custom.theme"
 # We use `lualatext` because, right now, it's the only engine
 # that supports fallback fonts, which we need for emojis.
 pdf-engine = "lualatex"
 metadata-file = "metadata.yml"
 
 [output.pandoc.profile.pdf.variables]
+mainfont = "CoreSansA45.ttf"
+mainfontoptions = [
+  "BoldFont=CoreSansA65.ttf",
+  "ItalicFont=CoreSansA45It.ttf",
+  "BoldItalicFont=CoreSansA65It.ttf",
+]
+sansfont = "CoreSansA45.ttf"
+sansfontoptions = [
+  "BoldFont=CoreSansA65.ttf",
+  "ItalicFont=CoreSansA45It.ttf",
+  "BoldItalicFont=CoreSansA65It.ttf",
+]
 # You can get these fonts here: https://fonts.google.com/selection?query=noto+color+
-mainfont = "Noto Serif"
-sansfont = "Noto Sans"
 monofont = "Noto Sans Mono"
 mainfontfallback = ["Noto Color Emoji:mode=harf"]
 sansfontfallback = ["Noto Color Emoji:mode=harf"]
 monofontfallback = [
   "Noto Color Emoji:mode=harf",
 ]
-linkcolor = "blue"
+linkcolor = "Links"
-urlcolor = "blue"
+urlcolor = "Links"
 urlstyle = "rm"
 documentclass = "book"
-fontsize = "11pt"
+fontsize = "10pt"
 geometry = "papersize={8in,10in},top=2cm,bottom=2cm,left=2.4cm,right=2.4cm"
 header-includes = [
+  "\\definecolor{Links}{HTML}{6200EE}",
   # Reduce font size of code blocks
   "\\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\\\\{\\},fontsize=\\small}",
 ]
@@ -62,20 +76,33 @@ metadata-file = "metadata.yml"
 pdf-engine = "lualatex"
 
 [output.pandoc.profile.paperback.variables]
+mainfont = "CoreSansA45.ttf"
+mainfontoptions = [
+  "BoldFont=CoreSansA65.ttf",
+  "ItalicFont=CoreSansA45It.ttf",
+  "BoldItalicFont=CoreSansA65It.ttf",
+]
+sansfont = "CoreSansA45.ttf"
+sansfontoptions = [
+  "BoldFont=CoreSansA65.ttf",
+  "ItalicFont=CoreSansA45It.ttf",
+  "BoldItalicFont=CoreSansA65It.ttf",
+]
 # You can get these fonts here: https://fonts.google.com/selection?query=noto+color+
-mainfont = "Noto Serif"
-sansfont = "Noto Sans"
 monofont = "Noto Sans Mono"
 mainfontfallback = ["Noto Color Emoji:mode=harf"]
 sansfontfallback = ["Noto Color Emoji:mode=harf"]
 monofontfallback = [
   "Noto Color Emoji:mode=harf",
 ]
+linkcolor = "Links"
+urlcolor = "Links"
 urlstyle = "rm"
 documentclass = "book"
-fontsize = "11pt"
+fontsize = "10pt"
 geometry = "papersize={8in,10in},top=2cm,bottom=2cm,left=2.8cm,right=2.5cm"
 header-includes = [
+  "\\definecolor{Links}{HTML}{6200EE}",
   # Reduce font size of code blocks
   "\\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\\\\{\\},fontsize=\\small}",
 ]
@@ -93,14 +120,10 @@ metadata-file = "metadata.yml"
 
 [output.pandoc.profile.html.variables]
 # You can get these fonts here: https://fonts.google.com/selection?query=noto+color+
-mainfont = "Noto Serif"
-sansfont = "Noto Sans"
 monofont = "Noto Sans Mono"
 mainfontfallback = ["Noto Color Emoji:mode=harf"]
 sansfontfallback = ["Noto Color Emoji:mode=harf"]
 monofontfallback = [
   "Noto Color Emoji:mode=harf",
 ]
-linkcolor = "blue"
-urlcolor = "blue"
 urlstyle = "rm"

book/custom.theme

@@ -0,0 +1,211 @@
+{
+    "text-color": "#c9d1d9",
+    "background-color": "#343942",
+    "line-number-color": null,
+    "line-number-background-color": null,
+    "text-styles": {
+        "Alert": {
+            "text-color": "#ff0000",
+            "background-color": null,
+            "bold": true,
+            "italic": false,
+            "underline": false
+        },
+        "Annotation": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": true,
+            "italic": true,
+            "underline": false
+        },
+        "Attribute": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "BaseN": {
+            "text-color": "#a5d6ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "BuiltIn": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Char": {
+            "text-color": "#a5d6ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Comment": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": false,
+            "italic": true,
+            "underline": false
+        },
+        "CommentVar": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": true,
+            "italic": true,
+            "underline": false
+        },
+        "Constant": {
+            "text-color": "#79c0ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "ControlFlow": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": true,
+            "italic": false,
+            "underline": false
+        },
+        "DataType": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "DecVal": {
+            "text-color": "#79c0ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Documentation": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": false,
+            "italic": true,
+            "underline": false
+        },
+        "Error": {
+            "text-color": "#ff0000",
+            "background-color": null,
+            "bold": true,
+            "italic": false,
+            "underline": false
+        },
+        "Extension": {
+            "text-color": null,
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Float": {
+            "text-color": "#79c0ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Function": {
+            "text-color": "#d2a8ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Import": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": true,
+            "italic": false,
+            "underline": false
+        },
+        "Information": {
+            "text-color": "#8b949e",
+            "background-color": null,
+            "bold": true,
+            "italic": true,
+            "underline": false
+        },
+        "Keyword": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": true,
+            "italic": false,
+            "underline": false
+        },
+        "Operator": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Other": {
+            "text-color": "#007020",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Preprocessor": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "SpecialChar": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "SpecialString": {
+            "text-color": "#03DAC5",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "String": {
+            "text-color": "#a5d6ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Variable": {
+            "text-color": "#a8daff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "VerbatimString": {
+            "text-color": "#a5d6ff",
+            "background-color": null,
+            "bold": false,
+            "italic": false,
+            "underline": false
+        },
+        "Warning": {
+            "text-color": "#60a0b0",
+            "background-color": null,
+            "bold": true,
+            "italic": true,
+            "underline": false
+        }
+    }
+}

book/link2alias.json

@@ -181,6 +181,7 @@
   "https://valgrind.org/docs/manual/dh-manual.html": "f2t",
   "https://veykril.github.io/tlborm/": "fz5",
   "https://without.boats/blog/the-scoped-task-trilemma/": "f67",
+  "https://www.amazon.com/dp/B0DJ14KQQG/": "f6g",
   "https://www.lpalmieri.com/": "ffv",
   "https://www.lpalmieri.com/posts/2020-12-11-zero-to-production-6-domain-modelling/": "f4t",
   "https://www.oreilly.com/library/view/programming-rust-2nd/9781492052586/": "f6y",

book/src/01_intro/00_welcome.md

@@ -34,8 +34,8 @@ also find solutions to all exercises in the
 
 ## Formats
 
-You can go through the course material [in the browser](https://rust-exercises.com/100-exercises/).\
+You can go through the course material [in the browser](https://rust-exercises.com/100-exercises/) or [download it as a PDF file](https://rust-exercises.com/100-exercises-to-learn-rust.pdf), for offline reading.\
-You can also [download it as a PDF file](https://rust-exercises.com/100-exercises-to-learn-rust.pdf), for offline reading.
+If you prefer to have the course material printed out, [buy a paperback copy on Amazon](https://www.amazon.com/dp/B0DJ14KQQG/).
 
 ## Structure
 

book/src/06_ticket_management/00_intro.md

@@ -8,7 +8,7 @@ store and retrieve tickets.
 The task will give us an opportunity to explore new Rust concepts, such as:
 
 - Stack-allocated arrays
-- `Vec`, a growable array type, and slices
+- `Vec`, a growable array type
 - `Iterator` and `IntoIterator`, for iterating over collections
 - Slices (`&[T]`), to work with parts of a collection
 - Lifetimes, to describe how long references are valid

book/src/06_ticket_management/07_combinators.md

@@ -1,7 +1,7 @@
 # Combinators
 
 Iterators can do so much more than `for` loops!\
-If you look at the documentation for the `Iterator` trait, you'll find a **vast** collections of
+If you look at the documentation for the `Iterator` trait, you'll find a **vast** collection of
 methods that you can leverage to transform, filter, and combine iterators in various ways.
 
 Let's mention the most common ones:

book/src/08_futures/01_async_fn.md

@@ -107,7 +107,7 @@ asynchronous programming in Rust.
 The entrypoint of your executable, the `main` function, must be a synchronous function.
 That's where you're supposed to set up and launch your chosen async runtime.
 
-Most runtimes provides a macro to make this easier. For `tokio`, it's `tokio::main`:
+Most runtimes provide a macro to make this easier. For `tokio`, it's `tokio::main`:
 
 ```rust
 #[tokio::main]

exercises/03_ticket_v1/02_validation/src/lib.rs

@@ -12,6 +12,7 @@ impl Ticket {
     //   - the `title` should be at most 50 bytes long.
     //   - the `description` should be at most 500 bytes long.
     //  The method should panic if any of the requirements are not met.
+    //  You can find the needed panic messages in the tests.
     //
     // You'll have to use what you learned in the previous exercises,
     // as well as some `String` methods. Use the documentation of Rust's standard library

exercises/06_ticket_management/14_index_mut/src/lib.rs

@@ -99,5 +99,11 @@ mod tests {
 
         let ticket = &store[id];
         assert_eq!(ticket.status, Status::InProgress);
+
+        let ticket = &mut store[&id];
+        ticket.status = Status::Done;
+
+        let ticket = &store[id];
+        assert_eq!(ticket.status, Status::Done);
     }
 }

site/_redirects

@@ -180,6 +180,7 @@
 /f2t https://valgrind.org/docs/manual/dh-manual.html
 /fz5 https://veykril.github.io/tlborm/
 /f67 https://without.boats/blog/the-scoped-task-trilemma/
+/f6g https://www.amazon.com/dp/B0DJ14KQQG/
 /ffv https://www.lpalmieri.com/
 /f4t https://www.lpalmieri.com/posts/2020-12-11-zero-to-production-6-domain-modelling/
 /f6y https://www.oreilly.com/library/view/programming-rust-2nd/9781492052586/