dc97d8dbc1d957e29c5009207809523c0ea3d793
[rust-101.git] / src / part01.rs
1 // Rust-101, Part 01: Expressions, Inherent methods
2 // ================================================
3
4 use std;
5
6 // Even though our code from the first part works, we can still learn a
7 // lot by making it prettier. To understand how, it is important to
8 // understand that Rust is an "expression-based" language. This means that most of the
9 // terms you write down are not just *statements* (executing code), but *expressions*
10 // (returning a value). This applies even to the body of entire functions!
11
12 // ## Expression-based programming
13 // For example, consider `sqr`:
14 fn sqr(i: i32) -> i32 { i * i }
15 // Between the curly braces, we are giving the *expression* that computes the return value.
16 // So we can just write `i * i`, the expression that returns the square if `i`!
17 // This is very close to how mathematicians write down functions (but with more types).
18
19 // Conditionals are also just expressions. You can compare this to the ternary `? :` operator
20 // from languages like C.
21 fn abs(i: i32) -> i32 { if i >= 0 { i } else { -i } }
22
23 // And the same applies to case distinction with `match`: Every `arm` of the match
24 // gives the expression that is returned in the respective case.
25 // (We repeat the definition from the previous part here.)
26 enum NumberOrNothing {
27     Number(i32),
28     Nothing
29 }
30 use self::NumberOrNothing::{Number,Nothing};
31 fn number_or_default(n: NumberOrNothing, default: i32) -> i32 {
32     match n {
33         Nothing => default,
34         Number(n) => n,
35     }
36 }
37
38 // With this fresh knowledge, let us now refactor `vec_min`.
39 fn vec_min(v: Vec<i32>) -> NumberOrNothing {
40     let mut min = Nothing;
41     for e in v {
42         // Notice that all we do here is compute a new value for `min`, and that it will always end
43         // up being a `Number` rather than `Nothing`. In Rust, the structure of the code
44         // can express this uniformity.
45         min = Number(match min {
46             Nothing => e,
47             Number(n) => std::cmp::min(n, e)
48         });
49     }
50     // The `return` keyword exists in Rust, but it is rarely used. Instead, we typically
51     // make use of the fact that the entire function body is an expression, so we can just
52     // write down the desired return value.
53     min
54 }
55
56 // Now that's already much shorter! Make sure you can go over the code above and actually understand
57 // every step of what's going on.
58
59 // ## Inherent implementations
60 // So much for `vec_min`. Let us now reconsider `print_number_or_nothing`. That function
61 // really belongs pretty close to the type `NumberOrNothing`. In C++ or Java, you would
62 // probably make it a method of the type. In Rust, we can achieve something very similar
63 // by providing an *inherent implementation*.
64 impl NumberOrNothing {
65     fn print(self) {
66         match self {
67             Nothing => println!("The number is: <nothing>"),
68             Number(n) => println!("The number is: {}", n),
69         };
70     }
71 }
72 // So, what just happened? Rust separates code from data, so the definition of the
73 // methods on an `enum` (and also on `struct`, which we will learn about later)
74 // is independent of the definition of the type. `self` is like `this` in other
75 // languages, and its type is always implicit. So `print` is now a method that
76 // takes as first argument a `NumberOrNothing`, just like `print_number_or_nothing`.
77 // 
78 // Try making `number_or_default` from above an inherent method as well!
79
80 // With our refactored functions and methods, `main` now looks as follows:
81 fn read_vec() -> Vec<i32> {
82     vec![18,5,7,2,9,27]
83 }
84 pub fn main() {
85     let vec = read_vec();
86     let min = vec_min(vec);
87     min.print();
88 }
89 // You will have to replace `part00` by `part01` in the `main` function in
90 // `main.rs` to run this code.
91
92 // **Exercise 01.1**: Write a funtion `vec_avg` that computes the average value of a `Vec<i32>`.
93 // 
94 // *Hint*: `vec.len()` returns the length of a vector `vec`.
95
96 // [index](main.html) | [previous](part00.html) | [next](part02.html)