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