src/part02.rs

   1 // Rust-101, Part 02: Generic types, Traits
   2 // ========================================
   3
   4 //@ Let us for a moment reconsider the type `NumberOrNothing`. Isn't it a bit annoying that we
   5 //@ had to hard-code the type `i32` in there? What if tomorrow, we want a `CharOrNothing`, and
   6 //@ later a `FloatOrNothing`? Certainly we don't want to re-write the type and all its inherent
   7 //@ methods.
   8
   9 // ## Generic datatypes
  10
  11 //@ The solution to this is called *generics* or *polymorphism* (the latter is Greek,
  12 //@ meaning "many shapes"). You may know something similar from C++ (where it's called
  13 //@ *templates*) or Java, or one of the many functional languages. So here, we define
  14 //@ a generic type `SomethingOrNothing`.
  15 pub enum SomethingOrNothing<T>  {
  16     Something(T),
  17     Nothing,
  18 }
  19 // Instead of writing out all the variants, we can also just import them all at once.
  20 pub use self::SomethingOrNothing::*;
  21 //@ What this does is define an entire family of types: We can now write
  22 //@ `SomethingOrNothing<i32>` to get back our `NumberOrNothing`.
  23 type NumberOrNothing = SomethingOrNothing<i32>;
  24 //@ However, we can also write `SomethingOrNothing<bool>` or even
  25 //@ `SomethingOrNothing<SomethingOrNothing<i32>>`. In fact, a type like `SomethingOrNothing` is so
  26 //@ useful that it is already present in the standard library: It's called an *option type*,
  27 //@ written `Option<T>`. Go check out its
  28 //@ [documentation](https://doc.rust-lang.org/stable/std/option/index.html)! (And don't worry,
  29 //@ there's indeed lots of material mentioned there that we have not covered yet.)
  30
  31 // ## Generic `impl`, Static functions
  32 //@ The types are so similar, that we can provide a generic function to construct a
  33 //@ `SomethingOrNothing<T>` from an `Option<T>`, and vice versa.
  34 //@
  35 //@ Notice the syntax for giving generic implementations to generic types: Think of the first `<T>`
  36 //@ as *declaring* a type variable ("I am doing something for all types `T`"), and the second `<T>`
  37 //@ as *using* that variable ("The thing I do, is implement `SomethingOrNothing<T>`").
  38 //@
  39 // Inside an `impl`, `Self` refers to the type we are implementing things for. Here, it is
  40 // an alias for `SomethingOrNothing<T>`.
  41 //@ Remember that `self` is the `this` of Rust, and implicitly has type `Self`.
  42 impl<T> SomethingOrNothing<T> {
  43     fn new(o: Option<T>) -> Self {
  44         match o { None => Nothing, Some(t) => Something(t) }        /*@*/
  45     }
  46
  47     fn to_option(self) -> Option<T> {
  48         match self { Nothing => None, Something(t) => Some(t) }     /*@*/
  49     }
  50 }
  51 //@ Observe how `new` does *not* have a `self` parameter. This corresponds to a `static` method
  52 //@ in Java or C++. In fact, `new` is the Rust convention for defining constructors: They are
  53 //@ nothing special, just static functions returning `Self`.
  54 //@
  55 // You can call static functions, and in particular constructors, as demonstrated in `call_constructor`.
  56 fn call_constructor(x: i32) -> SomethingOrNothing<i32> {
  57     SomethingOrNothing::new(Some(x))
  58 }
  59
  60 // ## Traits
  61 //@ Now that we have a generic `SomethingOrNothing`, wouldn't it be nice to also have a generic
  62 //@ `vec_min`? Of course, we can't take the minimum of a vector of *any* type. It has to be a type
  63 //@ supporting a `min` operation. Rust calls such properties that we may demand of types *traits*.
  64
  65 //@ So, as a first step towards a generic `vec_min`, we define a `Minimum` trait.
  66 //@ For now, just ignore the `Copy`, we will come back to this point later.
  67 //@ A `trait` is a lot like interfaces in Java: You define a bunch of functions
  68 //@ you want to have implemented, and their argument and return types. <br/>
  69 //@ The function `min` takes two arguments of the same type, but I made the
  70 //@ first argument the special `self` argument. I could, alternatively, have
  71 //@ made `min` a static function as follows: `fn min(a: Self, b: Self) -> Self`.
  72 //@ However, in Rust one typically prefers methods over static functions wherever possible.
  73 pub trait Minimum : Copy {
  74     fn min(self, b: Self) -> Self;
  75 }
  76
  77 //@ Next, we write `vec_min` as a generic function over a type `T` that we demand to satisfy the `Minimum` trait.
  78 //@ This requirement is called a *trait bound*.
  79 //@ The only difference to the version from the previous part is that we call `e.min(n)` instead
  80 //@ of `min_i32(n, e)`. Rust automatically figures out that `e` is of type `T`, which implements
  81 //@ the `Minimum` trait, and hence we can call that function.
  82 //@
  83 //@ There is a crucial difference to templates in C++: We actually have to declare which traits
  84 //@ we want the type to satisfy. If we left away the `Minimum`, Rust would have complained that
  85 //@ we cannot call `min`. Just try it! <br/>
  86 //@ This is in strong contrast to C++, where the compiler only checks such details when the
  87 //@ function is actually used.
  88 pub fn vec_min<T: Minimum>(v: Vec<T>) -> SomethingOrNothing<T> {
  89     let mut min = Nothing;
  90     for e in v {
  91         min = Something(match min {
  92             Nothing => e,
  93             // Here, we can now call the `min` function of the trait.
  94             Something(n) => {
  95                 e.min(n)                                            /*@*/
  96             }
  97         });
  98     }
  99     min
 100 }
 101 //@ Before going on, take a moment to ponder the flexibility of Rust's take on abstraction:
 102 //@ We just defined our own, custom trait (interface), and then implemented that trait
 103 //@ *for an existing type*. With the hierarchical approach of, e.g., C++ or Java,
 104 //@ that's not possible: We cannot make an existing type also inherit from our abstract base class
 105 //@ after the fact.
 106 //@
 107 //@ In case you are worried about performance, note that Rust performs *monomorphisation*
 108 //@ of generic functions: When you call `vec_min` with `T` being `i32`, Rust essentially goes
 109 //@ ahead and creates a copy of the function for this particular type, filling in all the blanks.
 110 //@ In this case, the call to `T::min` will become a call to our implementation *statically*. There
 111 //@ is no dynamic dispatch, like there would be for Java interface methods or C++ `virtual` methods.
 112 //@ This behavior is similar to C++ templates. The optimizer (Rust is using LLVM) then has all the
 113 //@ information it could want to, e.g., inline function calls.
 114
 115 // ## Trait implementations
 116 // To make `vec_min` usable with a `Vec<i32>`, we implement the `Minimum` trait for `i32`.
 117 impl Minimum for i32 {
 118     fn min(self, b: Self) -> Self {
 119         if self < b { self } else { b }                             /*@*/
 120     }
 121 }
 122
 123 // We again provide a `print` function.
 124 //@ This also shows that we can have multiple `impl` blocks for the same type (remember that
 125 //@ `NumberOrNothing` is just a type alias for `SomethingOrNothing<i32>`), and we can provide some
 126 //@ methods only for certain instances of a generic type.
 127 impl NumberOrNothing {
 128     pub fn print(self) {
 129         match self {
 130             Nothing => println!("The number is: <nothing>"),
 131             Something(n) => println!("The number is: {}", n),
 132         };
 133     }
 134 }
 135
 136 // Now we are ready to run our new code. Remember to change `main.rs` appropriately.
 137 //@ Rust figures out automatically that we want the `T` of `vec_min` to be `i32`, and
 138 //@ that `i32` implements `Minimum` and hence all is good.
 139 fn read_vec() -> Vec<i32> {
 140     vec![18,5,7,3,9,27]
 141 }
 142 pub fn main() {
 143     let vec = read_vec();
 144     let min = vec_min(vec);
 145     min.print();
 146 }
 147
 148 //@ If this printed `3`, then your generic `vec_min` is working! So get ready for the next part.
 149
 150 // **Exercise 02.1**: Change your program such that it computes the minimum of a `Vec<f32>` (where
 151 // `f32` is the type of 32-bit floating-point numbers). You should not change `vec_min` in any
 152 // way, obviously!
 153
 154 //@ [index](main.html) | [previous](part01.html) | [raw source](workspace/src/part02.rs) |
 155 //@ [next](part03.html)