src/part05.rs

   1 // Rust-101, Part 05: Clone
   2 // ========================
   3
   4 // ## Big Numbers
   5 //@ In the course of the next few parts, we are going to build a data-structure for computations with
   6 //@ *big* numbers. We would like to not have an upper bound to how large these numbers can get, with
   7 //@ the memory of the machine being the only limit.
   8 //@
   9 //@ We start by deciding how to represent such big numbers. One possibility here is
  10 //@ to use a vector "digits" of the number. This is like "1337" being a vector of four digits (1, 3, 3, 7),
  11 //@ except that we will use `u64` as type of our digits, meaning we have 2^64 individual digits. Now we just
  12 //@ have to decide the order in which we store numbers. I decided that we will store the least significant
  13 //@ digit first. This means that "1337" would actually become (7, 3, 3, 1). <br/>
  14 //@ Finally, we declare that there must not be any trailing zeros (corresponding to
  15 //@ useless leading zeros in our usual way of writing numbers). This is to ensure that
  16 //@ the same number can only be stored in one way.
  17
  18 //@ To write this down in Rust, we use a `struct`, which is a lot like structs in C:
  19 //@ Just a bunch of named fields. Every field can be private to the current module (which is the default),
  20 //@ or public (which is indicated by a `pub` in front of the name). For the sake of the tutorial, we make
  21 //@ `data` public - otherwise, the next parts of this course could not work on `BigInt`s. Of course, in a
  22 //@ real program, one would make the field private to ensure that the invariant (no trailing zeros) is maintained.
  23 pub struct BigInt {
  24     pub data: Vec<u64>, // least significant digit first, no trailing zeros
  25 }
  26
  27 // Now that we fixed the data representation, we can start implementing methods on it.
  28 impl BigInt {
  29     //@ Let's start with a constructor, creating a `BigInt` from an ordinary integer.
  30     //@ To create an instance of a struct, we write its name followed by a list of
  31     //@ fields and initial values assigned to them.
  32     pub fn new(x: u64) -> Self {
  33         if x == 0 {
  34             BigInt { data: vec![] }                                 /*@*/
  35         } else {
  36             BigInt { data: vec![x] }                                /*@*/
  37         }
  38     }
  39
  40     //@ It can often be useful to encode the invariant of a data-structure in code, so here
  41     //@ is a check that detects useless trailing zeros.
  42     pub fn test_invariant(&self) -> bool {
  43         if self.data.len() == 0 {
  44             true
  45         } else {
  46             self.data[self.data.len() - 1] != 0                     /*@*/
  47         }
  48     }
  49
  50     // Any vector of digits, which meets the structure of BigInt's `data` field, can be easily
  51     // converted into a big number just by removing trailing zeros. The `mut`
  52     // declaration for `v` here is just like the one in `let mut ...`: We completely own `v`, but Rust
  53     // still asks us to make our intention of modifying it explicit. This `mut` is *not* part of the
  54     // type of `from_vec` - the caller has to give up ownership of `v` anyway, so they don't care anymore
  55     // what you do to it.
  56     //
  57     // **Exercise 05.1**: Implement this function.
  58     //
  59     // *Hint*: You can use `pop` to remove the last element of a vector.
  60     pub fn from_vec(mut v: Vec<u64>) -> Self {
  61         unimplemented!()
  62     }
  63 }
  64
  65 // ## Cloning
  66 //@ If you take a close look at the type of `BigInt::from_vec`, you will notice that it
  67 //@ consumes the vector `v`. The caller hence loses access to its vector. However, there is something
  68 //@ we can do if we don't want that to happen: We can explicitly `clone` the vector,
  69 //@ which means that a full (or *deep*) copy will be performed. Technically,
  70 //@ `clone` takes a borrowed vector in the form of a shared reference, and returns a fully owned one.
  71 fn clone_demo() {
  72     let v = vec![0,1 << 16];
  73     let b1 = BigInt::from_vec((&v).clone());
  74     let b2 = BigInt::from_vec(v);
  75 }
  76 //@ Rust has special treatment for methods that borrow their `self` argument (like `clone`, or
  77 //@ like `test_invariant` above): It is not necessary to explicitly borrow the receiver of the
  78 //@ method. Hence you could replace `(&v).clone()` by `v.clone()` above. Just try it!
  79
  80 //@ To be clonable is a property of a type, and as such, naturally expressed with a trait.
  81 //@ In fact, Rust already comes with a trait `Clone` for exactly this purpose. We can hence
  82 //@ make our `BigInt` clonable as well.
  83 impl Clone for BigInt {
  84     fn clone(&self) -> Self {
  85         BigInt { data: self.data.clone() }                          /*@*/
  86     }
  87 }
  88 //@ Making a type clonable is such a common exercise that Rust can even help you doing it:
  89 //@ If you add `#[derive(Clone)]` right in front of the definition of `BigInt`, Rust will
  90 //@ generate an implementation of `Clone` that simply clones all the fields. Try it!
  91 //@ These `#[...]` annotations at types (and functions, modules, crates) are called *attributes*.
  92 //@ We will see some more examples of attributes later.
  93
  94 // We can also make the type `SomethingOrNothing<T>` implement `Clone`.
  95 //@ However, that can only work if `T` is `Clone`! So we have to add this bound to `T` when we introduce
  96 //@ the type variable.
  97 use part02::{SomethingOrNothing,Something,Nothing};
  98 impl<T: Clone> Clone for SomethingOrNothing<T> {
  99     fn clone(&self) -> Self {
 100         match *self {                                               /*@*/
 101             Nothing => Nothing,                                     /*@*/
 102             //@ In the second arm of the match, we need to talk about the value `v`
 103             //@ that's stored in `self`. However, if we were to write the pattern as
 104             //@ `Something(v)`, that would indicate that we *own* `v` in the code
 105             //@ after the arrow. That can't work though, we have to leave `v` owned by
 106             //@ whoever called us - after all, we don't even own `self`, we just borrowed it.
 107             //@ By writing `Something(ref v)`, we borrow `v` for the duration of the match
 108             //@ arm. That's good enough for cloning it.
 109             Something(ref v) => Something(v.clone()),               /*@*/
 110         }                                                           /*@*/
 111     }
 112 }
 113 //@ Again, Rust will generate this implementation automatically if you add
 114 //@ `#[derive(Clone)]` right before the definition of `SomethingOrNothing`.
 115
 116 // **Exercise 05.2**: Write some more functions on `BigInt`. What about a function that returns the number of
 117 // digits? The number of non-zero digits? The smallest/largest digit? Of course, these should all take `self` as a shared reference (i.e., in borrowed form).
 118
 119 // ## Mutation + aliasing considered harmful (part 2)
 120 //@ Now that we know how to create references to contents of an `enum` (like `v` above), there's another example we can look at for why we
 121 //@ have to rule out mutation in the presence of aliasing. First, we define an `enum` that can hold either
 122 //@ a number, or a string.
 123 enum Variant {
 124     Number(i32),
 125     Text(String),
 126 }
 127 //@ Now consider the following piece of code. Like above, `n` will be a reference to a part of `var`,
 128 //@ and since we wrote `ref mut`, the reference will be unique and mutable. In other words, right after the match, `ptr`
 129 //@ points to the number that's stored in `var`, where `var` is a `Number`. Remember that `_` means
 130 //@ "we don't care".
 131 fn work_on_variant(mut var: Variant, text: String) {
 132     let mut ptr: &mut i32;
 133     match var {
 134         Variant::Number(ref mut n) => ptr = n,
 135         Variant::Text(_) => return,
 136     }
 137     /* var = Variant::Text(text); */                                /* BAD! */
 138     *ptr = 1337;
 139 }
 140 //@ Now, imagine what would happen if we were permitted to also mutate `var`. We could, for example,
 141 //@ make it a `Text`. However, `ptr` still points to the old location! Hence `ptr` now points somewhere
 142 //@ into the representation of a `String`. By changing `ptr`, we manipulate the string in completely
 143 //@ unpredictable ways, and anything could happen if we were to use it again! (Technically, the first field
 144 //@ of a `String` is a pointer to its character data, so by overwriting that pointer with an integer,
 145 //@ we make it a completely invalid address. When the destructor of `var` runs, it would try to deallocate
 146 //@ that address, and Rust would eat your laundry - or whatever.)
 147 //@
 148 //@ I hope this example clarifies why Rust has to rule out mutation in the presence of aliasing *in general*,
 149 //@ not just for the specific case of a buffer being reallocated, and old pointers becoming hence invalid.
 150
 151 //@ [index](main.html) | [previous](part04.html) | [raw source](workspace/src/part05.rs) | [next](part06.html)