src/part03.rs

   1 // Rust-101, Part 03: Input
   2 // ========================
   3
   4 //@ In part 00, I promised that we would eventually replace `read_vec` by a function
   5 //@ that actually asks the user to enter a bunch of numbers. Unfortunately,
   6 //@ I/O is a complicated topic, so the code to do that is not exactly pretty - but well,
   7 //@ let's get that behind us.
   8
   9 // I/O is provided by the module `std::io`, so we first have to import that with `use`.
  10 // We also import the I/O *prelude*, which makes a bunch of commonly used I/O stuff
  11 // directly available.
  12 use std::io::prelude::*;
  13 use std::io;
  14
  15 //@ Let's now go over this function line-by-line. First, we call the constructor of `Vec`
  16 //@ to create an empty vector. As mentioned in the previous part, `new` here is just
  17 //@ a static function with no special treatment. While it is possible to call `new`
  18 //@ for a particular type (`Vec::<i32>::new()`), the common way to make sure we
  19 //@ get the right type is to annotate a type at the *variable*. It is this variable
  20 //@ that we interact with for the rest of the function, so having its type available
  21 //@ (and visible!) is much more useful. Without knowing the return type of `Vec::new`,
  22 //@ specifying its type parameter doesn't tell us all that much.
  23 fn read_vec() -> Vec<i32> {
  24     let mut vec: Vec<i32> = Vec::<i32>::new();
  25     // The central handle to the standard input is made available by the function `io::stdin`.
  26     let stdin = io::stdin();
  27     println!("Enter a list of numbers, one per line. End with Ctrl-D (Linux) or Ctrl-Z (Windows).");
  28     //@ We would now like to iterate over standard input line-by-line. We can use a `for` loop
  29     //@ for that, but there is a catch: What happens if there is some other piece of code running
  30     //@ concurrently, that also reads from standard input? The result would be a mess. Hence
  31     //@ Rust requires us to `lock` standard input if we want to perform large operations on
  32     //@ it. (See [the documentation](https://doc.rust-lang.org/stable/std/io/struct.Stdin.html) for more
  33     //@ details.)
  34     for line in stdin.lock().lines() {
  35         // Rust's type for (dynamic, growable) strings is `String`. However, our variable `line`
  36         // here is not yet of that type: It has type `io::Result<String>`.
  37         //@ The problem with I/O is that it can always go wrong. The type of `line` is a lot like `Option<String>` ("a `String` or
  38         //@ nothing"), but in the case of "nothing", there is additional information about the error.
  39         //@ Again, I recommend to check [the documentation](https://doc.rust-lang.org/stable/std/io/type.Result.html).
  40         //@ You will see that `io::Result` is actually just an alias for `Result`, so click on that to obtain
  41         //@ the list of all constructors and methods of the type.
  42
  43         //@ We will be lazy here and just assume that nothing goes wrong: `unwrap` returns the `String` if there is one,
  44         //@ and panics the program otherwise. Since a `Result` carries some details about the error that occurred,
  45         //@ there will be a somewhat reasonable error message. Still, you would not want a user to see such
  46         //@ an error, so in a "real" program, we would have to do proper error handling.
  47         //@ Can you find the documentation of `Result::unwrap`?
  48         //@
  49         // I chose the same name (`line`) for the new variable to ensure that I will never, accidentally,
  50         // access the "old" `line` again.
  51         let line = line.unwrap();
  52         // Now that we have our `String`, we want to make it an `i32`.
  53         //@ We first `trim` the `line` to remove leading and trailing whitespace.
  54         //@ `parse` is a method on `String` that can convert a string to anything. Try finding its documentation!
  55
  56         //@ In this case, Rust *could* figure out automatically that we need an `i32` (because of the return type
  57         //@ of the function), but that's a bit too much magic for my taste. We are being more explicit here:
  58         //@ `parse::<i32>` is `parse` with its generic type set to `i32`.
  59         match line.trim().parse::<i32>() {
  60             //@ `parse` returns again a `Result`, and this time we use a `match` to handle errors (like, the user entering
  61             //@ something that is not a number).
  62             //@ This is a common pattern in Rust: Operations that could go wrong will return `Option` or `Result`.
  63             //@ The only way to get to the value we are interested in is through pattern matching (and through helper functions
  64             //@ like `unwrap`). If we call a function that returns a `Result`, and throw the return value away,
  65             //@ the compiler will emit a warning. It is hence impossible for us to *forget* handling an error,
  66             //@ or to accidentally use a value that doesn't make any sense because there was an error producing it.
  67             Ok(num) => {
  68                 vec.push(num)                                       /*@*/
  69             },
  70             // We don't care about the particular error, so we ignore it with a `_`.
  71             Err(_) => {
  72                 println!("What did I say about numbers?")           /*@*/
  73             },
  74         }
  75     }
  76
  77     vec
  78 }
  79
  80 //@ So much for `read_vec`. If there are any questions left, the documentation of the respective function
  81 //@ should be very helpful. Try finding the one for `Vec::push`. I will not always provide the links,
  82 //@ as the documentation is quite easy to navigate and you should get used to that.
  83
  84 // For the rest of the code, we just re-use part 02 by importing it with `use`.
  85 //@ I already sneaked a bunch of `pub` in part 02 to make this possible: Only
  86 //@ items declared public can be imported elsewhere.
  87 use part02::{SomethingOrNothing,Something,Nothing,vec_min};
  88
  89 // If you update your `main.rs` to use part 03, `cargo run` should now ask you for some numbers,
  90 // and tell you the minimum. Neat, isn't it?
  91 pub fn main() {
  92     let vec = read_vec();
  93     let min = vec_min(vec);                                         /*@*/
  94     min.print();                                                    /*@*/
  95 }
  96
  97 // **Exercise 03.1**: Define a trait `Print` to write a generic version of `SomethingOrNothing::print`.
  98 // Implement that trait for `i32`, and change the code above to use it.
  99 // I will again provide a skeleton for this solution. It also shows how to attach bounds to generic
 100 // implementations (just compare it to the `impl` block from the previous exercise).
 101 // You can read this as "For all types `T` satisfying the `Print` trait, I provide an implementation
 102 // for `SomethingOrNothing<T>`".
 103 //
 104 // Notice that I called the function on `SomethingOrNothing` `print2` to disambiguate from the `print` defined previously.
 105 //
 106 // *Hint*: There is a macro `print!` for printing without appending a newline.
 107 pub trait Print {
 108     /* Add things here */
 109 }
 110 impl<T: Print> SomethingOrNothing<T> {
 111     fn print2(self) {
 112         unimplemented!()
 113     }
 114 }
 115
 116 // **Exercise 03.2**: Building on exercise 02.2, implement all the things you need on `f32` to make your
 117 // program work with floating-point numbers.
 118
 119 //@ [index](main.html) | [previous](part02.html) | [raw source](workspace/src/part03.rs) | [next](part04.html)