From 8e6c83b4cf8e61ad8a0fbbb42bdf968e93278736 Mon Sep 17 00:00:00 2001 From: Rogier 'DocWilco' Mulhuijzen Date: Fri, 29 Sep 2023 00:39:51 +0200 Subject: [PATCH] chore: make hints proper markdown Also rewrapped some hints to 80 columns so that they also look good in a terminal. closes #1698 --- info.toml | 614 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 379 insertions(+), 235 deletions(-) diff --git a/info.toml b/info.toml index 9930917..e3f66e2 100644 --- a/info.toml +++ b/info.toml @@ -5,7 +5,7 @@ name = "intro1" path = "exercises/intro/intro1.rs" mode = "compile" hint = """ -Remove the I AM NOT DONE comment in the exercises/intro/intro1.rs file +Remove the `I AM NOT DONE` comment in the `exercises/intro/intro1.rs` file to move on to the next exercise.""" [[exercises]] @@ -32,21 +32,29 @@ mode = "compile" hint = """ The compiler message is saying that Rust cannot infer the type that the variable binding `x` has with what is given here. -What happens if you annotate the first line in the main function with a type annotation? -What if you give x a value? + +What happens if you annotate the first line in the main function with a type +annotation? + +What if you give `x` a value? + What if you do both? -What type should x be, anyway? -What if x is the same type as 10? What if it's a different type?""" + +What type should `x` be, anyway? + +What if `x` is the same type as `10`? What if it's a different type?""" [[exercises]] name = "variables3" path = "exercises/variables/variables3.rs" mode = "compile" hint = """ -Oops! In this exercise, we have a variable binding that we've created on -in the first line in the main function, and we're trying to use it in the next line, +Oops! In this exercise, we have a variable binding that we've created on in the +first line in the `main` function, and we're trying to use it in the next line, but we haven't given it a value. -We can't print out something that isn't there; try giving x a value! + +We can't print out something that isn't there; try giving `x` a value! + This is an error that can cause bugs that's very easy to make in any programming language -- thankfully the Rust compiler has caught this for us!""" @@ -56,7 +64,7 @@ path = "exercises/variables/variables4.rs" mode = "compile" hint = """ In Rust, variable bindings are immutable by default. But here we're trying -to reassign a different value to x! There's a keyword we can use to make +to reassign a different value to `x`! There's a keyword we can use to make a variable binding mutable instead.""" [[exercises]] @@ -64,14 +72,17 @@ name = "variables5" path = "exercises/variables/variables5.rs" mode = "compile" hint = """ -In variables4 we already learned how to make an immutable variable mutable -using a special keyword. Unfortunately this doesn't help us much in this exercise -because we want to assign a different typed value to an existing variable. Sometimes -you may also like to reuse existing variable names because you are just converting -values to different types like in this exercise. +In `variables4` we already learned how to make an immutable variable mutable +using a special keyword. Unfortunately this doesn't help us much in this +exercise because we want to assign a different typed value to an existing +variable. Sometimes you may also like to reuse existing variable names because +you are just converting values to different types like in this exercise. + Fortunately Rust has a powerful solution to this problem: 'Shadowing'! -You can read more about 'Shadowing' in the book's section 'Variables and Mutability': +You can read more about 'Shadowing' in the book's section 'Variables and +Mutability': https://doc.rust-lang.org/book/ch03-01-variables-and-mutability.html#shadowing + Try to solve this exercise afterwards using this technique.""" [[exercises]] @@ -81,11 +92,14 @@ mode = "compile" hint = """ We know about variables and mutability, but there is another important type of variable available: constants. -Constants are always immutable and they are declared with keyword 'const' rather -than keyword 'let'. + +Constants are always immutable and they are declared with keyword `const` rather +than keyword `let`. + Constants types must also always be annotated. -Read more about constants and the differences between variables and constants under 'Constants' in the book's section 'Variables and Mutability': +Read more about constants and the differences between variables and constants +under 'Constants' in the book's section 'Variables and Mutability': https://doc.rust-lang.org/book/ch03-01-variables-and-mutability.html#constants """ @@ -116,8 +130,10 @@ mode = "compile" hint = """ This time, the function *declaration* is okay, but there's something wrong with the place where we're calling the function. + As a reminder, you can freely play around with different solutions in Rustlings! -Watch mode will only jump to the next exercise if you remove the I AM NOT DONE comment.""" +Watch mode will only jump to the next exercise if you remove the `I AM NOT +DONE` comment.""" [[exercises]] name = "functions4" @@ -125,10 +141,10 @@ path = "exercises/functions/functions4.rs" mode = "compile" hint = """ The error message points to the function `sale_price` and says it expects a type -after the `->`. This is where the function's return type should be -- take a look at -the `is_even` function for an example! +after the `->`. This is where the function's return type should be -- take a +look at the `is_even` function for an example! -Also: Did you figure out that, technically, u32 would be the more fitting type +Also: Did you figure out that, technically, `u32` would be the more fitting type for the prices here, since they can't be negative? If so, kudos!""" [[exercises]] @@ -137,8 +153,13 @@ path = "exercises/functions/functions5.rs" mode = "compile" hint = """ This is a really common error that can be fixed by removing one character. -It happens because Rust distinguishes between expressions and statements: expressions return a value based on their operand(s), and statements simply return a () type which behaves just like `void` in C/C++ language. -We want to return a value of `i32` type from the `square` function, but it is returning a `()` type... +It happens because Rust distinguishes between expressions and statements: +expressions return a value based on their operand(s), and statements simply +return a `()` type which behaves just like `void` in C/C++ language. + +We want to return a value of `i32` type from the `square` function, but it is +returning a `()` type... + They are not the same. There are two solutions: 1. Add a `return` ahead of `num * num;` 2. remove `;`, make it to be `num * num`""" @@ -151,9 +172,11 @@ path = "exercises/if/if1.rs" mode = "test" hint = """ It's possible to do this in one line if you would like! + Some similar examples from other languages: - In C(++) this would be: `a > b ? a : b` - In Python this would be: `a if a > b else b` + Remember in Rust that: - the `if` condition does not need to be surrounded by parentheses - `if`/`else` conditionals are expressions @@ -173,7 +196,8 @@ name = "if3" path = "exercises/if/if3.rs" mode = "test" hint = """ -In Rust, every arm of an `if` expression has to return the same type of value. Make sure the type is consistent across all arms.""" +In Rust, every arm of an `if` expression has to return the same type of value. +Make sure the type is consistent across all arms.""" # QUIZ 1 @@ -204,10 +228,13 @@ mode = "compile" hint = """ There's a shorthand to initialize Arrays with a certain size that does not require you to type in 100 items (but you certainly can if you want!). -For example, you can do: -let array = ["Are we there yet?"; 10]; -Bonus: what are some other things you could have that would return true +For example, you can do: +``` +let array = ["Are we there yet?"; 10]; +``` + +Bonus: what are some other things you could have that would return `true` for `a.len() >= 100`?""" [[exercises]] @@ -215,14 +242,14 @@ name = "primitive_types4" path = "exercises/primitive_types/primitive_types4.rs" mode = "test" hint = """ -Take a look at the Understanding Ownership -> Slices -> Other Slices section of the book: -https://doc.rust-lang.org/book/ch04-03-slices.html -and use the starting and ending (plus one) indices of the items in the Array -that you want to end up in the slice. +Take a look at the 'Understanding Ownership -> Slices -> Other Slices' section +of the book: https://doc.rust-lang.org/book/ch04-03-slices.html and use the +starting and ending (plus one) indices of the items in the `Array` that you +want to end up in the slice. -If you're curious why the first argument of `assert_eq!` does not -have an ampersand for a reference since the second argument is a -reference, take a look at the coercion chapter of the nomicon: +If you're curious why the first argument of `assert_eq!` does not have an +ampersand for a reference since the second argument is areference, take a look +at the coercion chapter of the nomicon: https://doc.rust-lang.org/nomicon/coercions.html""" [[exercises]] @@ -230,9 +257,11 @@ name = "primitive_types5" path = "exercises/primitive_types/primitive_types5.rs" mode = "compile" hint = """ -Take a look at the Data Types -> The Tuple Type section of the book: +Take a look at the 'Data Types -> The Tuple Type' section of the book: https://doc.rust-lang.org/book/ch03-02-data-types.html#the-tuple-type -Particularly the part about destructuring (second to last example in the section). +Particularly the part about destructuring (second to last example in the +section). + You'll need to make a pattern to bind `name` and `age` to the appropriate parts of the tuple. You can do it!!""" @@ -243,7 +272,7 @@ mode = "test" hint = """ While you could use a destructuring `let` for the tuple here, try indexing into it instead, as explained in the last example of the -Data Types -> The Tuple Type section of the book: +'Data Types -> The Tuple Type' section of the book: https://doc.rust-lang.org/book/ch03-02-data-types.html#the-tuple-type Now you have another tool in your toolbox!""" @@ -256,9 +285,10 @@ mode = "test" hint = """ In Rust, there are two ways to define a Vector. 1. One way is to use the `Vec::new()` function to create a new vector - and fill it with the `push()` method. + and fill it with the `push()` method. 2. The second way, which is simpler is to use the `vec![]` macro and - define your elements inside the square brackets. + define your elements inside the square brackets. + Check this chapter: https://doc.rust-lang.org/stable/book/ch08-01-vectors.html of the Rust book to learn more. """ @@ -268,13 +298,19 @@ name = "vecs2" path = "exercises/vecs/vecs2.rs" mode = "test" hint = """ -In the first function we are looping over the Vector and getting a reference to one `element` at a time. -To modify the value of that `element` we need to use the * dereference operator. You can learn more in this chapter of the Rust book: +In the first function we are looping over the Vector and getting a reference to +one `element` at a time. + +To modify the value of that `element` we need to use the `*` dereference +operator. You can learn more in this chapter of the Rust book: https://doc.rust-lang.org/stable/book/ch08-01-vectors.html#iterating-over-the-values-in-a-vector -In the second function this dereferencing is not necessary, because the map function expects the new value to be returned. +In the second function this dereferencing is not necessary, because the `map` +function expects the new value to be returned. + +After you've completed both functions, decide for yourself which approach you +like better. -After you've completed both functions, decide for yourself which approach you like better. What do you think is the more commonly used pattern under Rust developers? """ @@ -285,12 +321,14 @@ name = "move_semantics1" path = "exercises/move_semantics/move_semantics1.rs" mode = "test" hint = """ -So you've got the "cannot borrow immutable local variable `vec` as mutable" error on the line -where we push an element to the vector, right? -The fix for this is going to be adding one keyword, and the addition is NOT on the line where -we push to the vector (where the error is). +So you've got the "cannot borrow immutable local variable `vec` as mutable" +error on the line where we push an element to the vector, right? -Also: Try accessing `vec0` after having called `fill_vec()`. See what happens!""" +The fix for this is going to be adding one keyword, and the addition is NOT on +the line where we push to the vector (where the error is). + +Also: Try accessing `vec0` after having called `fill_vec()`. See what +happens!""" [[exercises]] name = "move_semantics2" @@ -300,14 +338,17 @@ hint = """ When running this exercise for the first time, you'll notice an error about "borrow of moved value". In Rust, when an argument is passed to a function and it's not explicitly returned, you can't use the original variable anymore. -We call this "moving" a variable. When we pass `vec0` into `fill_vec`, it's being -"moved" into `vec1`, meaning we can't access `vec0` anymore after the fact. -Rust provides a couple of different ways to mitigate this issue, feel free to try them all: -1. You could make another, separate version of the data that's in `vec0` and pass that - to `fill_vec` instead. +We call this "moving" a variable. When we pass `vec0` into `fill_vec`, it's +being "moved" into `vec1`, meaning we can't access `vec0` anymore after the +fact. + +Rust provides a couple of different ways to mitigate this issue, feel free to +try them all: +1. You could make another, separate version of the data that's in `vec0` and + pass that to `fill_vec` instead. 2. Make `fill_vec` borrow its argument instead of taking ownership of it, - and then copy the data within the function (`vec.clone()`) in order to return an owned - `Vec`. + and then copy the data within the function (`vec.clone()`) in order to + return an owned `Vec`. """ [[exercises]] @@ -340,9 +381,9 @@ path = "exercises/move_semantics/move_semantics5.rs" mode = "test" hint = """ Carefully reason about the range in which each mutable reference is in -scope. Does it help to update the value of referent (x) immediately after +scope. Does it help to update the value of referent (`x`) immediately after the mutable reference is taken? Read more about 'Mutable References' -in the book's section References and Borrowing': +in the book's section 'References and Borrowing': https://doc.rust-lang.org/book/ch04-02-references-and-borrowing.html#mutable-references. """ @@ -353,10 +394,14 @@ mode = "compile" hint = """ To find the answer, you can consult the book section "References and Borrowing": https://doc.rust-lang.org/stable/book/ch04-02-references-and-borrowing.html -The first problem is that `get_char` is taking ownership of the string. -So `data` is moved and can't be used for `string_uppercase` -`data` is moved to `get_char` first, meaning that `string_uppercase` cannot manipulate the data. -Once you've fixed that, `string_uppercase`'s function signature will also need to be adjusted. + +The first problem is that `get_char` is taking ownership of the string. So +`data` is moved and can't be used for `string_uppercase`. `data` is moved to +`get_char` first, meaning that `string_uppercase` cannot manipulate the data. + +Once you've fixed that, `string_uppercase`'s function signature will also need +to be adjusted. + Can you figure out how? Another hint: it has to do with the `&` character.""" @@ -368,33 +413,46 @@ name = "structs1" path = "exercises/structs/structs1.rs" mode = "test" hint = """ -Rust has more than one type of struct. Three actually, all variants are used to package related data together. -There are normal (or classic) structs. These are named collections of related data stored in fields. +Rust has more than one type of struct. Three actually, all variants are used to +package related data together. + +There are normal (or classic) structs. These are named collections of related +data stored in fields. + Tuple structs are basically just named tuples. -Finally, Unit-like structs. These don't have any fields and are useful for generics. + +Finally, Unit-like structs. These don't have any fields and are useful for +generics. In this exercise you need to complete and implement one of each kind. -Read more about structs in The Book: https://doc.rust-lang.org/book/ch05-01-defining-structs.html""" +Read more about structs in The Book: +https://doc.rust-lang.org/book/ch05-01-defining-structs.html""" [[exercises]] name = "structs2" path = "exercises/structs/structs2.rs" mode = "test" hint = """ -Creating instances of structs is easy, all you need to do is assign some values to its fields. +Creating instances of structs is easy, all you need to do is assign some values +to its fields. + There are however some shortcuts that can be taken when instantiating structs. -Have a look in The Book, to find out more: https://doc.rust-lang.org/stable/book/ch05-01-defining-structs.html#creating-instances-from-other-instances-with-struct-update-syntax""" +Have a look in The Book, to find out more: +https://doc.rust-lang.org/stable/book/ch05-01-defining-structs.html#creating-instances-from-other-instances-with-struct-update-syntax""" [[exercises]] name = "structs3" path = "exercises/structs/structs3.rs" mode = "test" hint = """ -For is_international: What makes a package international? Seems related to the places it goes through right? +For `is_international`: What makes a package international? Seems related to +the places it goes through right? -For get_fees: This method takes an additional argument, is there a field in the Package struct that this relates to? +For `get_fees`: This method takes an additional argument, is there a field in +the `Package` struct that this relates to? -Have a look in The Book, to find out more about method implementations: https://doc.rust-lang.org/book/ch05-03-method-syntax.html""" +Have a look in The Book, to find out more about method implementations: +https://doc.rust-lang.org/book/ch05-03-method-syntax.html""" # ENUMS @@ -418,9 +476,11 @@ path = "exercises/enums/enums3.rs" mode = "test" hint = """ As a first step, you can define enums to compile this code without errors. -and then create a match expression in `process()`. -Note that you need to deconstruct some message variants -in the match expression to get value in the variant.""" + +And then create a match expression in `process()`. + +Note that you need to deconstruct some message variants in the match expression +to get value in the variant.""" # STRINGS @@ -429,34 +489,40 @@ name = "strings1" path = "exercises/strings/strings1.rs" mode = "compile" hint = """ -The `current_favorite_color` function is currently returning a string slice with the `'static` -lifetime. We know this because the data of the string lives in our code itself -- it doesn't -come from a file or user input or another program -- so it will live as long as our program -lives. But it is still a string slice. There's one way to create a `String` by converting a -string slice covered in the Strings chapter of the book, and another way that uses the `From` -trait.""" +The `current_favorite_color` function is currently returning a string slice +with the `'static` lifetime. We know this because the data of the string lives +in our code itself -- it doesn't come from a file or user input or another +program -- so it will live as long as our program lives. + +But it is still a string slice. There's one way to create a `String` by +converting a string slice covered in the Strings chapter of the book, and +another way that uses the `From` trait.""" [[exercises]] name = "strings2" path = "exercises/strings/strings2.rs" mode = "compile" hint = """ -Yes, it would be really easy to fix this by just changing the value bound to `word` to be a -string slice instead of a `String`, wouldn't it?? There is a way to add one character to the -if statement, though, that will coerce the `String` into a string slice. +Yes, it would be really easy to fix this by just changing the value bound to +`word` to be a string slice instead of a `String`, wouldn't it?? There is a way +to add one character to the `if` statement, though, that will coerce the +`String` into a string slice. -Side note: If you're interested in learning about how this kind of reference conversion works, you can jump ahead in the book and read this part in the smart pointers chapter: https://doc.rust-lang.org/stable/book/ch15-02-deref.html#implicit-deref-coercions-with-functions-and-methods""" +Side note: If you're interested in learning about how this kind of reference +conversion works, you can jump ahead in the book and read this part in the +smart pointers chapter: +https://doc.rust-lang.org/stable/book/ch15-02-deref.html#implicit-deref-coercions-with-functions-and-methods""" [[exercises]] name = "strings3" path = "exercises/strings/strings3.rs" mode = "test" hint = """ -There's tons of useful standard library functions for strings. Let's try and use some of -them: ! +There's tons of useful standard library functions for strings. Let's try and use some of them: +https://doc.rust-lang.org/std/string/struct.String.html#method.trim -For the compose_me method: You can either use the `format!` macro, or convert the string -slice into an owned string, which you can then freely extend.""" +For the `compose_me` method: You can either use the `format!` macro, or convert +the string slice into an owned string, which you can then freely extend.""" [[exercises]] name = "strings4" @@ -484,6 +550,7 @@ The delicious_snacks module is trying to present an external interface that is different than its internal structure (the `fruits` and `veggies` modules and associated constants). Complete the `use` statements to fit the uses in main and find the one keyword missing for both constants. + Learn more at https://doc.rust-lang.org/book/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#re-exporting-names-with-pub-use""" [[exercises]] @@ -491,9 +558,9 @@ name = "modules3" path = "exercises/modules/modules3.rs" mode = "compile" hint = """ -UNIX_EPOCH and SystemTime are declared in the std::time module. Add a use statement -for these two to bring them into scope. You can use nested paths or the glob -operator to bring these two in using only one line.""" +`UNIX_EPOCH` and `SystemTime` are declared in the `std::time` module. Add a +`use` statement for these two to bring them into scope. You can use nested +paths or the glob operator to bring these two in using only one line.""" # HASHMAPS @@ -503,9 +570,10 @@ path = "exercises/hashmaps/hashmaps1.rs" mode = "test" hint = """ Hint 1: Take a look at the return type of the function to figure out - the type for the `basket`. + the type for the `basket`. + Hint 2: Number of fruits should be at least 5. And you have to put - at least three different types of fruits. + at least three different types of fruits. """ [[exercises]] @@ -522,9 +590,14 @@ name = "hashmaps3" path = "exercises/hashmaps/hashmaps3.rs" mode = "test" hint = """ -Hint 1: Use the `entry()` and `or_insert()` methods of `HashMap` to insert entries corresponding to each team in the scores table. +Hint 1: Use the `entry()` and `or_insert()` methods of `HashMap` to insert + entries corresponding to each team in the scores table. + Learn more at https://doc.rust-lang.org/stable/book/ch08-03-hash-maps.html#only-inserting-a-value-if-the-key-has-no-value -Hint 2: If there is already an entry for a given key, the value returned by `entry()` can be updated based on the existing value. + +Hint 2: If there is already an entry for a given key, the value returned by + `entry()` can be updated based on the existing value. + Learn more at https://doc.rust-lang.org/book/ch08-03-hash-maps.html#updating-a-value-based-on-the-old-value """ @@ -543,22 +616,28 @@ name = "options1" path = "exercises/options/options1.rs" mode = "test" hint = """ -Options can have a Some value, with an inner value, or a None value, without an inner value. -There's multiple ways to get at the inner value, you can use unwrap, or pattern match. Unwrapping -is the easiest, but how do you do it safely so that it doesn't panic in your face later?""" +Options can have a `Some` value, with an inner value, or a `None` value, +without an inner value. + +There's multiple ways to get at the inner value, you can use `unwrap`, or +pattern match. Unwrapping is the easiest, but how do you do it safely so that +it doesn't panic in your face later?""" [[exercises]] name = "options2" path = "exercises/options/options2.rs" mode = "test" hint = """ -check out: -https://doc.rust-lang.org/rust-by-example/flow_control/if_let.html -https://doc.rust-lang.org/rust-by-example/flow_control/while_let.html +Check out: -Remember that Options can be stacked in if let and while let. -For example: Some(Some(variable)) = variable2 -Also see Option::flatten +- https://doc.rust-lang.org/rust-by-example/flow_control/if_let.html +- https://doc.rust-lang.org/rust-by-example/flow_control/while_let.html + +Remember that `Option`s can be stacked in `if let` and `while let`. + +For example: `Some(Some(variable)) = variable2` + +Also see `Option::flatten` """ [[exercises]] @@ -566,10 +645,11 @@ name = "options3" path = "exercises/options/options3.rs" mode = "compile" hint = """ -The compiler says a partial move happened in the `match` -statement. How can this be avoided? The compiler shows the correction -needed. After making the correction as suggested by the compiler, do -read: https://doc.rust-lang.org/std/keyword.ref.html""" +The compiler says a partial move happened in the `match` statement. How can +this be avoided? The compiler shows the correction needed. + +After making the correction as suggested by the compiler, do read: +https://doc.rust-lang.org/std/keyword.ref.html""" # ERROR HANDLING @@ -579,16 +659,15 @@ path = "exercises/error_handling/errors1.rs" mode = "test" hint = """ `Ok` and `Err` are one of the variants of `Result`, so what the tests are saying -is that `generate_nametag_text` should return a `Result` instead of an -`Option`. +is that `generate_nametag_text` should return a `Result` instead of an `Option`. To make this change, you'll need to: - - update the return type in the function signature to be a Result that - could be the variants `Ok(String)` and `Err(String)` - - change the body of the function to return `Ok(stuff)` where it currently - returns `Some(stuff)` - - change the body of the function to return `Err(error message)` where it - currently returns `None`""" + - update the return type in the function signature to be a `Result` that could be the variants `Ok(String)` and `Err(String)` + - change the body of the function to return `Ok(stuff)` where it currently + returns `Some(stuff)` + - change the body of the function to return `Err(error message)` where it + currently returns `None`""" [[exercises]] name = "errors2" @@ -597,9 +676,12 @@ mode = "test" hint = """ One way to handle this is using a `match` statement on `item_quantity.parse::()` where the cases are `Ok(something)` and -`Err(something)`. This pattern is very common in Rust, though, so there's -a `?` operator that does pretty much what you would make that match statement -do for you! Take a look at this section of the Error Handling chapter: +`Err(something)`. + +This pattern is very common in Rust, though, so there's a `?` operator that +does pretty much what you would make that match statement do for you! + +Take a look at this section of the 'Error Handling' chapter: https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html#a-shortcut-for-propagating-errors-the--operator and give it a try!""" @@ -608,32 +690,38 @@ name = "errors3" path = "exercises/error_handling/errors3.rs" mode = "compile" hint = """ -If other functions can return a `Result`, why shouldn't `main`? It's a fairly common -convention to return something like Result<(), ErrorType> from your main function. -The unit (`()`) type is there because nothing is really needed in terms of positive -results.""" +If other functions can return a `Result`, why shouldn't `main`? It's a fairly +common convention to return something like `Result<(), ErrorType>` from your +main function. + +The unit (`()`) type is there because nothing is really needed in terms of +positive results.""" [[exercises]] name = "errors4" path = "exercises/error_handling/errors4.rs" mode = "test" hint = """ -`PositiveNonzeroInteger::new` is always creating a new instance and returning an `Ok` result. -It should be doing some checking, returning an `Err` result if those checks fail, and only -returning an `Ok` result if those checks determine that everything is... okay :)""" +`PositiveNonzeroInteger::new` is always creating a new instance and returning +an `Ok` result. + +It should be doing some checking, returning an `Err` result if those checks +fail, and only returning an `Ok` result if those checks determine that +everything is... okay :)""" [[exercises]] name = "errors5" path = "exercises/error_handling/errors5.rs" mode = "compile" hint = """ -There are two different possible `Result` types produced within `main()`, which are -propagated using `?` operators. How do we declare a return type from `main()` that allows both? +There are two different possible `Result` types produced within `main()`, which +are propagated using `?` operators. How do we declare a return type from +`main()` that allows both? -Under the hood, the `?` operator calls `From::from` on the error value to convert it to a boxed -trait object, a `Box`. This boxed trait object is polymorphic, and since all -errors implement the `error::Error` trait, we can capture lots of different errors in one "Box" -object. +Under the hood, the `?` operator calls `From::from` on the error value to +convert it to a boxed trait object, a `Box`. This boxed trait +object is polymorphic, and since all errors implement the `error::Error` trait, +we can capture lots of different errors in one "Box" object. Check out this section of the book: https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html#a-shortcut-for-propagating-errors-the--operator @@ -653,7 +741,7 @@ hint = """ This exercise uses a completed version of `PositiveNonzeroInteger` from errors4. -Below the line that TODO asks you to change, there is an example of using +Below the line that `TODO` asks you to change, there is an example of using the `map_err()` method on a `Result` to transform one type of error into another. Try using something similar on the `Result` from `parse()`. You might use the `?` operator to return early from the function, or you might @@ -672,7 +760,9 @@ name = "generics1" path = "exercises/generics/generics1.rs" mode = "compile" hint = """ -Vectors in Rust make use of generics to create dynamically sized arrays of any type. +Vectors in Rust make use of generics to create dynamically sized arrays of any +type. + You need to tell the compiler what type we are pushing onto this vector.""" [[exercises]] @@ -680,7 +770,8 @@ name = "generics2" path = "exercises/generics/generics2.rs" mode = "test" hint = """ -Currently we are wrapping only values of type 'u32'. +Currently we are wrapping only values of type `u32`. + Maybe we could update the explicit references to this data type somehow? If you are still stuck https://doc.rust-lang.org/stable/book/ch10-01-syntax.html#in-method-definitions @@ -702,7 +793,8 @@ name = "traits2" path = "exercises/traits/traits2.rs" mode = "test" hint = """ -Notice how the trait takes ownership of 'self',and returns `Self`. +Notice how the trait takes ownership of `self`, and returns `Self`. + Try mutating the incoming string vector. Have a look at the tests to see what the result should look like! @@ -726,8 +818,8 @@ name = "traits4" path = "exercises/traits/traits4.rs" mode = "test" hint = """ -Instead of using concrete types as parameters you can use traits. Try replacing the -'??' with 'impl ' +Instead of using concrete types as parameters you can use traits. Try replacing +the '??' with 'impl ' See the documentation at: https://doc.rust-lang.org/book/ch10-02-traits.html#traits-as-parameters """ @@ -737,8 +829,8 @@ name = "traits5" path = "exercises/traits/traits5.rs" mode = "compile" hint = """ -To ensure a parameter implements multiple traits use the '+ syntax'. Try replacing the -'??' with 'impl <> + <>'. +To ensure a parameter implements multiple traits use the '+ syntax'. Try +replacing the '??' with 'impl <> + <>'. See the documentation at: https://doc.rust-lang.org/book/ch10-02-traits.html#specifying-multiple-trait-bounds-with-the--syntax """ @@ -750,8 +842,10 @@ name = "quiz3" path = "exercises/quiz3.rs" mode = "test" hint = """ -To find the best solution to this challenge you're going to need to think back to your -knowledge of traits, specifically Trait Bound Syntax - you may also need this: `use std::fmt::Display;`.""" +To find the best solution to this challenge you're going to need to think back +to your knowledge of traits, specifically 'Trait Bound Syntax' + +You may also need this: `use std::fmt::Display;`.""" # LIFETIMES @@ -768,17 +862,22 @@ name = "lifetimes2" path = "exercises/lifetimes/lifetimes2.rs" mode = "compile" hint = """ -Remember that the generic lifetime 'a will get the concrete lifetime that is equal to the smaller of the lifetimes of x and y. -You can take at least two paths to achieve the desired result while keeping the inner block: -1. Move the string2 declaration to make it live as long as string1 (how is result declared?) -2. Move println! into the inner block""" +Remember that the generic lifetime `'a` will get the concrete lifetime that is +equal to the smaller of the lifetimes of `x` and `y`. + +You can take at least two paths to achieve the desired result while keeping the +inner block: +1. Move the `string2` declaration to make it live as long as `string1` (how is + `result` declared?) +2. Move `println!` into the inner block""" [[exercises]] name = "lifetimes3" path = "exercises/lifetimes/lifetimes3.rs" mode = "compile" hint = """ -If you use a lifetime annotation in a struct's fields, where else does it need to be added?""" +If you use a lifetime annotation in a struct's fields, where else does it need +to be added?""" # TESTS @@ -787,30 +886,39 @@ name = "tests1" path = "exercises/tests/tests1.rs" mode = "test" hint = """ -You don't even need to write any code to test -- you can just test values and run that, even -though you wouldn't do that in real life :) `assert!` is a macro that needs an argument. -Depending on the value of the argument, `assert!` will do nothing (in which case the test will -pass) or `assert!` will panic (in which case the test will fail). So try giving different values -to `assert!` and see which ones compile, which ones pass, and which ones fail :)""" +You don't even need to write any code to test -- you can just test values and +run that, even though you wouldn't do that in real life. :) + +`assert!` is a macro that needs an argument. Depending on the value of the +argument, `assert!` will do nothing (in which case the test will pass) or +`assert!` will panic (in which case the test will fail). + +So try giving different values to `assert!` and see which ones compile, which +ones pass, and which ones fail :)""" [[exercises]] name = "tests2" path = "exercises/tests/tests2.rs" mode = "test" hint = """ -Like the previous exercise, you don't need to write any code to get this test to compile and -run. `assert_eq!` is a macro that takes two arguments and compares them. Try giving it two -values that are equal! Try giving it two arguments that are different! Try giving it two values -that are of different types! Try switching which argument comes first and which comes second!""" +Like the previous exercise, you don't need to write any code to get this test +to compile and run. + +`assert_eq!` is a macro that takes two arguments and compares them. Try giving +it two values that are equal! Try giving it two arguments that are different! +Try giving it two values that are of different types! Try switching which +argument comes first and which comes second!""" [[exercises]] name = "tests3" path = "exercises/tests/tests3.rs" mode = "test" hint = """ -You can call a function right where you're passing arguments to `assert!` -- so you could do -something like `assert!(having_fun())`. If you want to check that you indeed get false, you -can negate the result of what you're doing using `!`, like `assert!(!having_fun())`.""" +You can call a function right where you're passing arguments to `assert!`. So +you could do something like `assert!(having_fun())`. + +If you want to check that you indeed get `false`, you can negate the result of +what you're doing using `!`, like `assert!(!having_fun())`.""" [[exercises]] name = "tests4" @@ -818,7 +926,9 @@ path = "exercises/tests/tests4.rs" mode = "test" hint = """ We expect method `Rectangle::new()` to panic for negative values. + To handle that you need to add a special attribute to the test function. + You can refer to the docs: https://doc.rust-lang.org/stable/book/ch11-01-writing-tests.html#checking-for-panics-with-should_panic""" @@ -830,14 +940,20 @@ path = "exercises/iterators/iterators1.rs" mode = "test" hint = """ Step 1: -We need to apply something to the collection `my_fav_fruits` before we start to go through -it. What could that be? Take a look at the struct definition for a vector for inspiration: + +We need to apply something to the collection `my_fav_fruits` before we start to +go through it. What could that be? Take a look at the struct definition for a +vector for inspiration: https://doc.rust-lang.org/std/vec/struct.Vec.html + Step 2 & step 3: + Very similar to the lines above and below. You've got this! + Step 4: -An iterator goes through all elements in a collection, but what if we've run out of -elements? What should we expect here? If you're stuck, take a look at + +An iterator goes through all elements in a collection, but what if we've run +out of elements? What should we expect here? If you're stuck, take a look at https://doc.rust-lang.org/std/iter/trait.Iterator.html for some ideas. """ @@ -846,50 +962,55 @@ name = "iterators2" path = "exercises/iterators/iterators2.rs" mode = "test" hint = """ -Step 1 +Step 1: + The variable `first` is a `char`. It needs to be capitalized and added to the remaining characters in `c` in order to return the correct `String`. + The remaining characters in `c` can be viewed as a string slice using the `as_str` method. + The documentation for `char` contains many useful methods. https://doc.rust-lang.org/std/primitive.char.html -Step 2 -Create an iterator from the slice. Transform the iterated values by applying -the `capitalize_first` function. Remember to collect the iterator. +Step 2: -Step 3. -This is surprisingly similar to the previous solution. Collect is very powerful -and very general. Rust just needs to know the desired type.""" +Create an iterator from the slice. Transform the iterated values by applying +the `capitalize_first` function. Remember to `collect` the iterator. + +Step 3: + +This is surprisingly similar to the previous solution. `collect` is very +powerful and very general. Rust just needs to know the desired type.""" [[exercises]] name = "iterators3" path = "exercises/iterators/iterators3.rs" mode = "test" hint = """ -The divide function needs to return the correct error when even division is not -possible. +The `divide` function needs to return the correct error when even division is +not possible. -The division_results variable needs to be collected into a collection type. +The `division_results` variable needs to be collected into a collection type. -The result_with_list function needs to return a single Result where the success -case is a vector of integers and the failure case is a DivisionError. +The `result_with_list` function needs to return a single `Result` where the +success case is a vector of integers and the failure case is a `DivisionError`. -The list_of_results function needs to return a vector of results. +The `list_of_results` function needs to return a vector of results. -See https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.collect for how -the `FromIterator` trait is used in `collect()`. This trait is REALLY powerful! It -can make the solution to this exercise infinitely easier.""" +See https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.collect for +how the `FromIterator` trait is used in `collect()`. This trait is REALLY +powerful! It can make the solution to this exercise infinitely easier.""" [[exercises]] name = "iterators4" path = "exercises/iterators/iterators4.rs" mode = "test" hint = """ -In an imperative language, you might write a for loop that updates -a mutable variable. Or, you might write code utilizing recursion -and a match clause. In Rust you can take another functional -approach, computing the factorial elegantly with ranges and iterators. +In an imperative language, you might write a `for` loop that updates a mutable +variable. Or, you might write code utilizing recursion and a match clause. In +Rust you can take another functional approach, computing the factorial +elegantly with ranges and iterators. Hint 2: Check out the `fold` and `rfold` methods!""" @@ -898,16 +1019,17 @@ name = "iterators5" path = "exercises/iterators/iterators5.rs" mode = "test" hint = """ -The documentation for the std::iter::Iterator trait contains numerous methods +The documentation for the `std::iter::Iterator` trait contains numerous methods that would be helpful here. -The collection variable in count_collection_iterator is a slice of HashMaps. It -needs to be converted into an iterator in order to use the iterator methods. +The `collection` variable in `count_collection_iterator` is a slice of +`HashMap`s. It needs to be converted into an iterator in order to use the +iterator methods. -The fold method can be useful in the count_collection_iterator function. +The `fold` method can be useful in the `count_collection_iterator` function. -For a further challenge, consult the documentation for Iterator to find -a different method that could make your code more compact than using fold.""" +For a further challenge, consult the documentation for `Iterator` to find +a different method that could make your code more compact than using `fold`.""" # SMART POINTERS @@ -916,17 +1038,23 @@ name = "box1" path = "exercises/smart_pointers/box1.rs" mode = "test" hint = """ -Step 1 -The compiler's message should help: since we cannot store the value of the actual type -when working with recursive types, we need to store a reference (pointer) to its value. -We should, therefore, place our `List` inside a `Box`. More details in the book here: -https://doc.rust-lang.org/book/ch15-01-box.html#enabling-recursive-types-with-boxes +Step 1: -Step 2 -Creating an empty list should be fairly straightforward (hint: peek at the assertions). -For a non-empty list keep in mind that we want to use our Cons "list builder". -Although the current list is one of integers (i32), feel free to change the definition -and try other types! +The compiler's message should help: since we cannot store the value of the +actual type when working with recursive types, we need to store a reference +(pointer) to its value. + +We should, therefore, place our `List` inside a `Box`. More details in the book +here: https://doc.rust-lang.org/book/ch15-01-box.html#enabling-recursive-types-with-boxes + +Step 2: + +Creating an empty list should be fairly straightforward (hint: peek at the +assertions). + +For a non-empty list keep in mind that we want to use our `Cons` "list builder". +Although the current list is one of integers (`i32`), feel free to change the +definition and try other types! """ [[exercises]] @@ -934,11 +1062,16 @@ name = "rc1" path = "exercises/smart_pointers/rc1.rs" mode = "test" hint = """ -This is a straightforward exercise to use the Rc type. Each Planet has -ownership of the Sun, and uses Rc::clone() to increment the reference count of the Sun. -After using drop() to move the Planets out of scope individually, the reference count goes down. -In the end the sun only has one reference again, to itself. See more at: -https://doc.rust-lang.org/book/ch15-04-rc.html +This is a straightforward exercise to use the `Rc` type. Each `Planet` has +ownership of the `Sun`, and uses `Rc::clone()` to increment the reference count +of the `Sun`. + +After using `drop()` to move the `Planet`s out of scope individually, the +reference count goes down. + +In the end the `Sun` only has one reference again, to itself. + +See more at: https://doc.rust-lang.org/book/ch15-04-rc.html * Unfortunately Pluto is no longer considered a planet :( """ @@ -952,11 +1085,12 @@ Make `shared_numbers` be an `Arc` from the numbers vector. Then, in order to avoid creating a copy of `numbers`, you'll need to create `child_numbers` inside the loop but still in the main thread. -`child_numbers` should be a clone of the Arc of the numbers instead of a +`child_numbers` should be a clone of the `Arc` of the numbers instead of a thread-local copy of the numbers. This is a simple exercise if you understand the underlying concepts, but if this -is too much of a struggle, consider reading through all of Chapter 16 in the book: +is too much of a struggle, consider reading through all of Chapter 16 in the +book: https://doc.rust-lang.org/stable/book/ch16-00-concurrency.html """ @@ -965,7 +1099,8 @@ name = "cow1" path = "exercises/smart_pointers/cow1.rs" mode = "test" hint = """ -If Cow already owns the data it doesn't need to clone it when to_mut() is called. +If `Cow` already owns the data it doesn't need to clone it when `to_mut()` is +called. Check out https://doc.rust-lang.org/std/borrow/enum.Cow.html for documentation on the `Cow` type. @@ -985,7 +1120,9 @@ A challenge with multi-threaded applications is that the main thread can finish before the spawned threads are completed. https://doc.rust-lang.org/book/ch16-01-threads.html#waiting-for-all-threads-to-finish-using-join-handles -Use the JoinHandles to wait for each thread to finish and collect their results. +Use the `JoinHandle`s to wait for each thread to finish and collect their +results. + https://doc.rust-lang.org/std/thread/struct.JoinHandle.html """ @@ -1001,13 +1138,14 @@ mutate the data at a time. Take a look at this section of the book: https://doc.rust-lang.org/book/ch16-03-shared-state.html#atomic-reference-counting-with-arct and keep reading if you'd like more hints :) - Do you now have an `Arc` `Mutex` `JobStatus` at the beginning of main? Like: -`let status = Arc::new(Mutex::new(JobStatus { jobs_completed: 0 }));` -Similar to the code in the example in the book that happens after the text -that says "Sharing a Mutex Between Multiple Threads". If not, give that a try! If you -do and would like more hints, keep reading!! +``` +let status = Arc::new(Mutex::new(JobStatus { jobs_completed: 0 })); +``` +Similar to the code in the example in the book that happens after the text +that says 'Sharing a Mutex Between Multiple Threads'. If not, give that a +try! If you do and would like more hints, keep reading!! Make sure neither of your threads are holding onto the lock of the mutex while they are sleeping, since this will prevent the other thread from @@ -1023,12 +1161,15 @@ name = "threads3" path = "exercises/threads/threads3.rs" mode = "test" hint = """ -An alternate way to handle concurrency between threads is to use -a mpsc (multiple producer, single consumer) channel to communicate. -With both a sending end and a receiving end, it's possible to -send values in one thread and receive them in another. -Multiple producers are possible by using clone() to create a duplicate -of the original sending end. +An alternate way to handle concurrency between threads is to use an `mpsc` +(multiple producer, single consumer) channel to communicate. + +With both a sending end and a receiving end, it's possible to send values in +one thread and receive them in another. + +Multiple producers are possible by using clone() to create a duplicate of the +original sending end. + See https://doc.rust-lang.org/book/ch16-02-message-passing.html for more info. """ @@ -1071,13 +1212,14 @@ path = "exercises/macros/macros4.rs" mode = "compile" hint = """ You only need to add a single character to make this compile. -The way macros are written, it wants to see something between each -"macro arm", so it can separate them. -That's all the macro exercises we have in here, but it's barely even -scratching the surface of what you can do with Rust's macros. For a more -thorough introduction, you can have a read through the little book of Rust -macros: https://veykril.github.io/tlborm/""" +The way macros are written, it wants to see something between each "macro arm", +so it can separate them. + +That's all the macro exercises we have in here, but it's barely even scratching +the surface of what you can do with Rust's macros. For a more thorough +introduction, you can have a read through 'The Little Book of Rust Macros': +https://veykril.github.io/tlborm/""" # CLIPPY @@ -1087,21 +1229,22 @@ path = "exercises/clippy/clippy1.rs" mode = "clippy" hint = """ Rust stores the highest precision version of any long or infinite precision -mathematical constants in the Rust standard library. +mathematical constants in the Rust standard library: https://doc.rust-lang.org/stable/std/f32/consts/index.html -We may be tempted to use our own approximations for certain mathematical constants, -but clippy recognizes those imprecise mathematical constants as a source of -potential error. +We may be tempted to use our own approximations for certain mathematical +constants, but clippy recognizes those imprecise mathematical constants as a +source of potential error. + See the suggestions of the clippy warning in compile output and use the -appropriate replacement constant from std::f32::consts...""" +appropriate replacement constant from `std::f32::consts`...""" [[exercises]] name = "clippy2" path = "exercises/clippy/clippy2.rs" mode = "clippy" hint = """ -`for` loops over Option values are more clearly expressed as an `if let`""" +`for` loops over `Option` values are more clearly expressed as an `if let`""" [[exercises]] name = "clippy3" @@ -1131,8 +1274,8 @@ name = "from_str" path = "exercises/conversions/from_str.rs" mode = "test" hint = """ -The implementation of FromStr should return an Ok with a Person object, -or an Err with an error if the string is not valid. +The implementation of `FromStr` should return an `Ok` with a `Person` object, +or an `Err` with an error if the string is not valid. This is almost like the `from_into` exercise, but returning errors instead of falling back to a default value. @@ -1153,7 +1296,8 @@ path = "exercises/conversions/try_from_into.rs" mode = "test" hint = """ Follow the steps provided right before the `TryFrom` implementation. -You can also use the example at https://doc.rust-lang.org/std/convert/trait.TryFrom.html +You can also use the example at +https://doc.rust-lang.org/std/convert/trait.TryFrom.html Is there an implementation of `TryFrom` in the standard library that can both do the required integer conversion and check the range of the input? @@ -1174,4 +1318,4 @@ name = "as_ref_mut" path = "exercises/conversions/as_ref_mut.rs" mode = "test" hint = """ -Add AsRef or AsMut as a trait bound to the functions.""" +Add `AsRef` or `AsMut` as a trait bound to the functions."""