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