src/part00.rs

   1 // Rust-101, Part 00: Algebraic datatypes
   2 // ======================================
   3
   4 // As our first piece of Rust code, we want to write a function that computes the
   5 // minimum of a list.
   6
   7 //@ ## Getting started
   8 //@ Let us start by thinking about the *type* of our function. Rust forces us to give the types of
   9 //@ all arguments, and the return type, before we even start writing the body. In the case of our minimum
  10 //@ function, we may be inclined to say that it returns a number. But then we would be in trouble: What's
  11 //@ the minimum of an empty list? The type of the function says we have to return *something*.
  12 //@ We could just choose 0, but that would be kind of arbitrary. What we need
  13 //@ is a type that is "a number, or nothing". Such a type (of multiple exclusive options)
  14 //@ is called an "algebraic datatype", and Rust lets us define such types with the keyword `enum`.
  15 //@ Coming from C(++), you can think of such a type as a `union`, together with a field that
  16 //@ stores the variant of the union that's currently used.
  17
  18 // An `enum` for "a number or nothing" could look as follows:
  19 enum NumberOrNothing {
  20     Number(i32),
  21     Nothing
  22 }
  23 //@ Notice that `i32` is the type of (signed, 32-bit) integers. To write down the type of
  24 //@ the minimum function, we need just one more ingredient: `Vec<i32>` is the type of
  25 //@ (growable) arrays of numbers, and we will use that as our list type.
  26
  27 // Observe how in Rust, the return type comes *after* the arguments.
  28 fn vec_min(vec: Vec<i32>) -> NumberOrNothing {
  29     //@ In the function, we first need some variable to store the minimum as computed so far.
  30     //@ Since we start out with nothing computed, this will again be a
  31     //@ "number or nothing":
  32     let mut min = NumberOrNothing::Nothing;
  33     //@ We do not have to write a type next to `min`, Rust can figure that out automatically
  34     //@ (a bit like `auto` in C++11). Also notice the `mut`: In Rust, variables are
  35     //@ immutable per default, and you need to tell Rust if you want
  36     //@ to change a variable later.
  37
  38     // Now we want to *iterate* over the list. Rust has some nice syntax for iterators:
  39     for el in vec {
  40         // So `el` is an element of the list. We need to update `min` accordingly, but how do we get the current
  41         // number in there? This is what pattern matching can do:
  42         match min {
  43             // In this case (*arm*) of the `match`, `min` is currently nothing, so let's just make it the number `el`.
  44             NumberOrNothing::Nothing => {
  45                 min = NumberOrNothing::Number(el);                  /*@*/
  46             },
  47             // In this arm, `min` is currently the number `n`, so let's compute the new minimum and store it.
  48             //@ We will write the function `min_i32` just after we completed this one.
  49             NumberOrNothing::Number(n) => {
  50                 let new_min = min_i32(n, el);                       /*@*/
  51                 min = NumberOrNothing::Number(new_min);             /*@*/
  52             }
  53         }
  54         //@ Notice that Rust makes sure you did not forget to handle any case in your `match`. We say
  55         //@ that the pattern matching has to be *exhaustive*.
  56     }
  57     // Finally, we return the result of the computation.
  58     return min;
  59 }
  60
  61 // Now that we reduced the problem to computing the minimum of two integers, let's do that.
  62 fn min_i32(a: i32, b: i32) -> i32 {
  63     if a < b {
  64         return a;                                                   /*@*/
  65     } else {
  66         return b;                                                   /*@*/
  67     }
  68 }
  69
  70 // Phew. We wrote our first Rust function! But all this `NumberOrNothing::` is getting kind of
  71 // ugly. Can't we do that nicer?
  72
  73 // Indeed, we can: The following line tells Rust to take
  74 // the constructors of `NumberOrNothing` into the local namespace.
  75 // Try moving that above the function, and removing all the occurrences of `NumberOrNothing::`.
  76 use self::NumberOrNothing::{Number,Nothing};
  77
  78 // To call this function, we now just need a list. Of course, ultimately we want to ask the user for
  79 // a list of numbers, but for now, let's just hard-code something.
  80
  81 //@ `vec!` is a *macro* (as indicated by `!`) that constructs a constant `Vec<_>` with the given
  82 //@ elements.
  83 fn read_vec() -> Vec<i32> {
  84     vec![18,5,7,1,9,27]                                             /*@*/
  85 }
  86
  87 // Of course, we would also like to actually see the result of the computation, so we need to print the result.
  88 //@ Of course Rust can print numbers, but after calling `vec_min`, we have a `NumberOrNothing`.
  89 //@ So let's write a small helper function that prints such values.
  90
  91 //@ `println!` is again a macro, where the first argument is a *format string*. For
  92 //@ now, you just need to know that `{}` is the placeholder for a value, and that Rust
  93 //@ will check at compile-time that you supplied the right number of arguments.
  94 fn print_number_or_nothing(n: NumberOrNothing) {
  95     match n {                                                       /*@*/
  96         Nothing => println!("The number is: <nothing>"),            /*@*/
  97         Number(n) => println!("The number is: {}", n),              /*@*/
  98     };                                                              /*@*/
  99 }
 100
 101 // Putting it all together:
 102 pub fn main() {
 103     let vec = read_vec();
 104     let min = vec_min(vec);
 105     print_number_or_nothing(min);
 106 }
 107
 108 //@ You can now use `cargo build` to compile your *crate*. That's Rust's name for a *compilation unit*, which in
 109 //@ the case of Rust means an application or a library. <br/>
 110 // Finally, try `cargo run` on the console to run it.
 111
 112 //@ Yay, it said "1"! That's actually the right answer. Okay, we could have
 113 //@ computed that ourselves, but that's beside the point. More importantly:
 114 //@ You completed the first part of the course.
 115
 116 //@ [index](main.html) | previous | [raw source](https://www.ralfj.de/git/rust-101.git/blob_plain/HEAD:/workspace/src/part00.rs) | [next](part01.html)