src/part02.rs

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