diff --git a/src/librustc/ty/steal.rs b/src/librustc/ty/steal.rs index 0da937d036648..e62872477c47c 100644 --- a/src/librustc/ty/steal.rs +++ b/src/librustc/ty/steal.rs @@ -1,6 +1,24 @@ use std::cell::{Ref, RefCell}; use std::mem; +/// The `Steal` struct is intended to used as the value for a query. +/// Specifically, we sometimes have queries (*cough* MIR *cough*) +/// where we create a large, complex value that we want to iteratively +/// update (e.g., optimize). We could clone the value for each +/// optimization, but that'd be expensive. And yet we don't just want +/// to mutate it in place, because that would spoil the idea that +/// queries are these pure functions that produce an immutable value +/// (since if you did the query twice, you could observe the +/// mutations). So instead we have the query produce a `&'tcx +/// Steal>` (to be very specific). Now we can read from this +/// as much as we want (using `borrow()`), but you can also +/// `steal()`. Once you steal, any further attempt to read will panic. +/// Therefore we know that -- assuming no ICE -- nobody is observing +/// the fact that the MIR was updated. +/// +/// Obviously, whenever you have a query that yields a `Steal` value, +/// you must treat it with caution, and make sure that you know that +/// -- once the value is stolen -- it will never be read from again. pub struct Steal { value: RefCell> } @@ -14,7 +32,7 @@ impl Steal { pub fn borrow(&self) -> Ref { Ref::map(self.value.borrow(), |opt| match *opt { - None => panic!("attempted to read from stolen value"), + None => bug!("attempted to read from stolen value"), Some(ref v) => v }) }