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