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