45caaec1557685dcc464dc01984c4a61d234204e
[rust-101.git] / 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 import that.
10 // We also import the I/O *prelude*, which brings 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 `io::stdin()`.
26     let stdin = io::stdin();
27     println!("Enter a list of numbers, one per line. End with Ctrl-D.");
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](http://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. The problem with I/O is that it can always go wrong, so
37         // `line` has type `io::Result<String>`. This 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](http://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`. `parse` is a method on `String` that
53         // can convert a string to anything. Try finding it's documentation!
54
55         // In this case, Rust *could* figure out automatically that we need an `i32` (because of the return type
56         // of the function), but that's a bit too much magic for my taste. We are being more explicit here:
57         // `parse::<i32>` is `parse` with its generic type set to `i32`.
58         match line.parse::<i32>() {
59         // `parse` returns again a `Result`, and this time we use a `match` to handle errors (like, the user entering
60         // something that is not a number).
61         // This is a common pattern in Rust: Operations that could go wrong will return `Option` or `Result`.
62         // The only way to get to the value we are interested in is through pattern matching (and through helper functions
63         // like `unwrap()`). If we call a function that returns a `Result`, and throw the return value away,
64         // the compiler will emit a warning. It is hence impossible for us to *forget* handling an error,
65         // or to accidentally use a value that doesn't make any sense because there was an error producing it.
66             Ok(num) => vec.push(num),
67             Err(_) => println!("What did I say about numbers?"),
68         }
69     }
70
71     vec
72 }
73
74 // So much for `read_vec`. If there are any questions left, the documentation of the respective function
75 // should be very helpful. Try finding the one for `Vec::push`. I will not always provide the links,
76 // as the documentation is quite easy to navigate and you should get used to that.
77
78 // For the rest of the code, we just re-use part 02 by importing it with `use`.
79 // I already sneaked a bunch of `pub` in part 02 to make this possible: Only
80 // items declared public can be imported elsewhere.
81 use part02::{SomethingOrNothing,Something,Nothing,vec_min};
82
83 // If you update your `main.rs` to use part 03, `cargo run` should now ask you for some numbers,
84 // and tell you the minimum. Neat, isn't it?
85 pub fn main() {
86     let vec = read_vec();
87     let min = vec_min(vec);
88     min.print();
89 }
90
91 // **Exercise 03.1**: Define a trait `Print` to write a generic version of `SomethingOrNothing::print`.
92 // Implement that trait for `i32`, and change the code above to use it.
93 // I will again provide a skeleton for this solution. It also shows how to attach bounds to generic
94 // implementations (just compare it to the `impl` block from the previous exercise).
95 // You can read this as "For all types `T` satisfying the `Print` trait, I provide an implementation
96 // for `SomethingOrNothing<T>`".
97 // 
98 // Notice that I called the function on `SomethingOrNothing` `print2` to disambiguate from the `print` defined previously.
99 // 
100 // *Hint*: There is a macro `print!` for printing without appending a newline.
101 trait Print {
102     /* Add things here */
103 }
104 impl<T: Print> SomethingOrNothing<T> {
105     fn print2(self) {
106         unimplemented!()
107     }
108 }
109
110 // [index](main.html) | [previous](part02.html) | [next](part04.html)