4e5c5fd7b343151e28ef54f3bb59e71ac52da6c6
[rust-101.git] / src / part11.rs
1 // Rust-101, Part 11: Trait Objects, Box, Rc, Lifetime bounds
2 // ==========================================================
3
4 //@ We will play around with closures a bit more. Let us implement some kind of generic "callback"
5 //@ mechanism, providing two functions: Registering a new callback, and calling all registered callbacks. There will be two
6 //@ versions, so to avoid clashes of names, we put them into modules.
7 mod callbacks {
8     //@ First of all, we need to find a way to store the callbacks. Clearly, there will be a `Vec` involved, so that we can
9     //@ always grow the number of registered callbacks. A callback will be a closure, i.e., something implementing
10     //@ `FnMut(i32)` (we want to call this multiple times, so clearly `FnOnce` would be no good). So our first attempt may be the following.
11     // For now, we just decide that the callbacks have an argument of type `i32`.
12     struct CallbacksV1<F: FnMut(i32)> {
13         callbacks: Vec<F>,
14     }
15     //@ However, this will not work. Remember how the "type" of a closure is specific to the environment of captured variables. Different closures
16     //@ all implementing `FnMut(i32)` may have different types. However, a `Vec<F>` is a *uniformly typed* vector.
17
18     //@ We will thus need a way to store things of *different* types in the same vector. We know all these types implement `FnMut(i32)`. For this scenario,
19     //@ Rust provides *trait objects*: The truth is, `FnMut(i32)` is not just a trait. It is also a type, that can be given to anything implementing
20     //@ this trait. So, we may write the following.
21     /* struct CallbacksV2 {
22         callbacks: Vec<FnMut(i32)>,
23     } */
24     //@ But, Rust complains about this definition. It says something about "Sized". What's the trouble? See, for many things we want to do, it is crucial that
25     //@ Rust knows the precise, fixed size of the type - that is, how large this type will be when represented in memory. For example, for a `Vec`, the
26     //@ elements are stored one right after the other. How should that be possible, without a fixed size? The trouble is, `FnMut(i32)` could be of any size.
27     //@ We don't know how large that "type that implemenets `FnMut(i32)`" is. Rust calls this an *unsized* type. Whenever we introduce a type variable, Rust
28     //@ will implicitly add a bound to that variable, demanding that it is sized. That's why we did not have to worry about this so far. <br/>
29     //@ You can opt-out of this implicit bound by saying `T: ?Sized`. Then `T` may or may not be sized.
30
31     //@ So, what can we do, if we can't store the callbacks in a vector? We can put them in a box. Semantically, `Box<T>` is a lot like `T`: You fully own
32     //@ the data stored there. On the machine, however, `Box<T>` is a *pointer* to `T`. It is a lot like `std::unique_ptr` in C++. In our current example,
33     //@ the important bit is that since it's a pointer, `T` can be unsized, but `Box<T>` itself will always be sized. So we can put it in a `Vec`.
34     pub struct Callbacks {
35         callbacks: Vec<Box<FnMut(i32)>>,
36     }
37
38     impl Callbacks {
39         // Now we can provide some functions. The constructor should be straight-forward.
40         pub fn new() -> Self {
41             Callbacks { callbacks: Vec::new() }                     /*@*/
42         }
43
44         // Registration simply stores the callback.
45         pub fn register(&mut self, callback: Box<FnMut(i32)>) {
46             self.callbacks.push(callback);                          /*@*/
47         }
48
49         // And here we call all the stored callbacks.
50         pub fn call(&mut self, val: i32) {
51             // Since they are of type `FnMut`, we need to mutably iterate. Notice that boxes dereference implicitly.
52             for callback in self.callbacks.iter_mut() {
53                 callback(val);                                      /*@*/
54             }
55         }
56     }
57
58     // Now we are ready for the demo.
59     pub fn demo(c: &mut Callbacks) {
60         c.register(Box::new(|val| println!("Callback 1: {}", val)));
61         c.call(0);
62
63         //@ We can even register callbacks that modify their environment. Rust will again attempt to borrow `count`. However,
64         //@ that doesn't work out this time: Since we want to put this thing in a `Box`, it could live longer than the function
65         //@ we are in. Then the borrow of `count` would become invalid. We have to explicitly tell Rust to `move` ownership of the
66         //@ variable into the closure. Its environment will then contain a `usize` rather than a `&mut uszie`, and have
67         //@ no effect on this local variable anymore.
68         let mut count: usize = 0;
69         c.register(Box::new(move |val| { count = count+1; println!("Callback 2, {}. time: {}", count, val); } ));
70         c.call(1); c.call(2);
71     }
72 }
73
74 // Remember to edit `main.rs` to run the demo.
75 pub fn main() {
76     let mut c = callbacks::Callbacks::new();
77     callbacks::demo(&mut c);
78 }
79
80 mod callbacks_clone {
81     //@ So, this worked great, didn't it! There's one point though that I'd like to emphasize: One cannot `clone` a closure.
82     //@ Hence it becomes impossible to implement `Clone` for our `Callbacks` type. What could we do about this?
83
84     //@ You already learned about `Box` above. `Box` is an example of a *smart pointer*: It's like a pointer (in the C
85     //@ sense), but with some additional smarts to it. For `Box`, that's the part about ownership. Once you drop the box, the
86     //@ content it points to will be deleted. <br/>
87     //@ Another example of a smart pointer is `Rc<T>`. This is short for *reference-counter*, so you can already guess how
88     //@ this pointer is smart: It has a reference count. You can `clone` an `Rc` as often as you want, that doesn't affect the
89     //@ data it contains at all. It only creates more references to the same data. Once all the references are gone, the data is deleted.
90     //@ 
91     //@ Wait a moment, you may say here. Multiple references to the same data? That's aliasing! Indeed, we have to be careful.
92     //@ Once data is stored in an `Rc`, it is read-only: By dereferencing the smart `Rc`, you can only get a shared borrow of the data.
93     use std::rc::Rc;
94
95     //@ Because of this read-only restriction, we cannot use `FnMut` here: We'd be unable to call the function with a mutable borrow
96     //@ of it's environment! So we have to go with `Fn`. We wrap that in an `Rc`, and then Rust happily derives `Clone` for us.
97     #[derive(Clone)]
98     pub struct Callbacks {
99         callbacks: Vec<Rc<Fn(i32)>>,
100     }
101
102     impl Callbacks {
103         pub fn new() -> Self {
104             Callbacks { callbacks: Vec::new() }                     /*@*/
105         }
106
107         // For the `register` function, we don't actually have to use trait objects in the argument.
108         //@ We can make this function generic, such that it will be instantiated with some concrete closure type `F`
109         //@ and do the creation of the `Rc` and the conversion to `Fn(i32)` itself.
110         
111         //@ For this to work, we need to demand that the type `F` does not contain any short-lived borrows. After all, we will store it
112         //@ in our list of callbacks indefinitely. `'static` is a lifetime, the lifetime of the entire program. We can use lifetimes
113         //@ as bounds on types, to demand that anything in (an element of) the type lives at least as long as this lifetime. That bound was implicit in the `Box`
114         //@ above, and it is the reason we could not have the borrowed `count` in the closure in `demo`.
115         pub fn register<F: Fn(i32)+'static>(&mut self, callback: F) {
116             self.callbacks.push(Rc::new(callback));             /*@*/
117         }
118
119         pub fn call(&mut self, val: i32) {
120             // We only need a shared iterator here. `Rc` also implicitly dereferences, so we can simply call the callback.
121             for callback in self.callbacks.iter() {
122                 callback(val);                                      /*@*/
123             }
124         }
125     }
126
127     // The demo works just as above. Our counting callback doesn't work anymore though, because we are using `Fn` now.
128     fn demo(c: &mut Callbacks) {
129         c.register(|val| println!("Callback 1: {}", val));
130         c.call(0); c.call(1);
131     }
132 }
133
134 // **Exercise 11.1**: We made the arbitrary choice of using `i32` for the arguments. Generalize the data-structures above
135 // to work with an arbitrary type `T` that's passed to the callbacks. Since you need to call multiple callbacks with the
136 // same `t: T`, you will either have to restrict `T` to `Copy` types, or pass a borrow.
137
138 //@ ## Run-time behavior
139 //@ When you run the program above, how does Rust know what to do with the callbacks? Since an unsized type lacks some information,
140 //@ a *pointer* to such a type (be it a `Box`, an `Rc` or a borrow) will need to complete this information. We say that pointers to
141 //@ trait objects are *fat*. They store not only the address of the object, but (in the case of trait objects) also a *vtable*: A
142 //@ table of function pointers, determining the code that's run when a trait method is called. There are some restrictions for traits to be usable
143 //@ as trait objects. This is called *object safety* and described in [the documentation](http://doc.rust-lang.org/stable/book/trait-objects.html) and [the reference](http://doc.rust-lang.org/reference.html#trait-objects).
144 //@ 
145 //@ Whenever you write a generic function, you have a choice: You can make it polymorphic, like our `vec_min`. Or you
146 //@ can use trait objects, like the first `register` above. The latter will result in only a single compiled version (rather
147 //@ than one version per type it is instantiated with). This makes for smaller code, but you pay the overhead of the virtual function calls.
148 //@ Isn't it beautiful how traits can handle both of these cases (and much more, as we saw, like closures and operator overloading) nicely?
149
150 //@ [index](main.html) | [previous](part10.html) | [next](main.html)