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 // 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 to 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 `SomethingOrNothing<SomethingOrNothing<i32>>`.
  25 // In fact, such a type is so useful that it is already present in the standard
  26 // library: It's called an *option type*, written `Option<T>`.
  27 // Go check out its [documentation](http://doc.rust-lang.org/stable/std/option/index.html)!
  28 // (And don't worry, there's indeed lots of material mentioned there that we did not cover yet.)
  29
  30 // The types are so similar, that we can provide a generic function to construct a `SomethingOrNothing<T>`
  31 // from an `Option<T>`, and vice versa.
  32
  33 // **Exercise**: Implement such functions! I provided a skeleton of the solution. Here,
  34 // `panic!` is another macro. This one terminates execution with the given message.
  35 //
  36 // Notice the syntax for giving generic implementations to generic types: Think of the first `<T>`
  37 // as *declaring* a type variable ("I am doing something for all types `T`"), and the second `<T>` as
  38 // *using* that variable ("The thing I do, is implement `SomethingOrNothing<T>`").
  39 //
  40 // Inside an `impl`, `Self` refers to the type we are implementing things for. Here, it is
  41 // an alias for `SomethingOrNothing<T>`.
  42 // Remember that `self` is the `this` of Rust, and implicitly has type `Self`.
  43 impl<T> SomethingOrNothing<T> {
  44     fn new(o: Option<T>) -> Self {
  45         panic!("Not yet implemented.")
  46     }
  47
  48     fn to_option(self) -> Option<T> {
  49         panic!("Not yet implemented.")
  50     }
  51 }
  52 // Observe how `new` does *not* have a `self` parameter. This corresponds to a `static` method
  53 // in Java or C++. In fact, `new` is the Rust convention for defining constructors: They are
  54 // nothing special, just static functions returning `Self`.
  55 //
  56 // You can call static functions, and in particular constructors, as demonstrated in `call_constructor`.
  57 fn call_constructor(x: i32) -> SomethingOrNothing<i32> {
  58     SomethingOrNothing::new(Some(x))
  59 }
  60
  61 // Now that we have a generic `SomethingOrNothing`, wouldn't it be nice to also gave 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 to 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 function 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 `std::cmp::min(n, e)`. Rust automatically figures out that `n` 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             Something(n) => e.min(n)
  94         });
  95     }
  96     min
  97 }
  98 // Before going on, take a moment to ponder the flexibility of Rust's take on abstraction:
  99 // We just defined our own, custom trait (interface), and then implemented that trait
 100 // *for an existing type*. With the hierarchical approach of, e.g., C++ or Java,
 101 // that's not possible: We cannot make an existing type suddenly also inherit from our abstract base class.
 102 //
 103 // In case you are worried about performance, note that Rust performs *monomorphisation*
 104 // of generic functions: When you call `vec_min` with `T` being `i32`, Rust essentially goes
 105 // ahead and creates a copy of the function for this particular type, filling in all the blanks.
 106 // In this case, the call to `T::min` will become a call to our implementation *statically*. There is
 107 // no dynamic dispatch, like there would be for Java interface methods or C++ `virtual` methods.
 108 // This behavior is similar to C++ templates. The optimizer (Rust is using LLVM) then has all the
 109 // information it could want to, e.g., inline function calls.
 110
 111 // To make the function usable with a `Vec<i32>`, we implement the `Minimum` trait for `i32`.
 112 impl Minimum for i32 {
 113     fn min(self, b: Self) -> Self {
 114         std::cmp::min(self, b)
 115     }
 116 }
 117
 118 // In order to run our code and see the result, we again provide a `print` function.
 119 // This also shows that we can have multiple `impl` blocks for the same type (remember
 120 // that `NumberOrNothing` is just a type alias for `SomethingOrNothing<i32>`), and we
 121 // can provide some methods only for certain instances of a generic type.
 122 impl NumberOrNothing{
 123     pub fn print(self) {
 124         match self {
 125             Nothing => println!("The number is: <nothing>"),
 126             Something(n) => println!("The number is: {}", n),
 127         };
 128     }
 129 }
 130
 131 // Now we are again ready to run our code. Remember to change `main.rs` appropriately.
 132 // Rust figures out automatically that we want the `T` of `vec_min` to be `i32`, and
 133 // that `i32` implements `Minimum` and hence all is good.
 134 fn read_vec() -> Vec<i32> {
 135     vec![18,5,7,3,9,27]
 136 }
 137 pub fn main() {
 138     let vec = read_vec();
 139     let min = vec_min(vec);
 140     min.print();
 141 }
 142
 143 // If this printed `3`, then you generic `vec_min` is working! So get ready for the next part.
 144
 145 // [index](main.html) | [previous](part01.html) | [next](part03.html)