1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
//! Macros for taking ownership, _starring Liam Neeson_ //! //! This module exports the `take!` macro which allows you to express ownership on one or more //! variables. //! //! All of them expand into some sort of `let v = v;`. See the [`take!`](macro.take.html) //! for more details and possible use cases. //! //! ### Special Thanks //! This crate was created through the community efforts at [/r/rust]. Special thanks to: //! //! - [/u/CUViper] for poiting out the tradeoffs of this strategy. //! - [/u/jasonkdark] for the initial implementation. //! //! > _[In the voice of Liam Neeson]_ //! > _If you let my object go now, that'll be the end of it. But if you don't, I will look for you, //! > I will find you, and I will kill you._ //! //! Whoa Liam Neeson, you'll get your object back, I swear! //! //! [/r/rust]: https://www.reddit.com/r/rust/comments/7u29r3/help_me_make_the_own_macro_and_understand_its_use/ //! [/u/CUViper]: https://www.reddit.com/r/rust/comments/7u29r3/help_me_make_the_own_macro_and_understand_its_use/dthcvlp/ //! [/u/jasonkdark]: https://www.reddit.com/r/rust/comments/7u29r3/help_me_make_the_own_macro_and_understand_its_use/dthfcnt/ /// Take ownership of specific variables. /// /// One of the main use cases is closures. Closures try to be "smart" about how /// much scope they capture. If you don't mutate a variable they take `&var`, /// if you do mutate they take `&mut var`. However, if you require ownership /// you use `move`, i.e. `move || {... do stuff with var...}`... _right_? /// /// The problem with `move` is that it moves _every_ variable that is referenced. If you only need /// to move a few variables it can be a pain. Interestingly, you can tell the compiler to only move /// _specific_ variables like so: /// /// ```rust /// # let (x, y) = (1, 2); /// let x = x; /// let y = y; /// // ... etc /// ``` /// /// But this is quite silly and not obvious to someone who doesn't know about it. Instead, use the /// `take!` macro and your code will be self documenting. /// /// You can also use `take!` to perform a clone or assert to the compiler that you are only taking /// a certain kind of reference. See the examples for more. /// /// ## Downsides /// If you use this macro (or `let x = x`) then the closure becomes `FnOnce`. /// /// Unfortunately the best explanation of the trade offs is [currently a reddit /// thread][reddit]. Please help flush out these docs more! /// /// [reddit]: https://www.reddit.com/r/rust/comments/7u29r3/help_me_make_the_own_macro_and_understand_its_use/dthcvlp/ /// /// # Examples /// /// ## Changing Ownership /// It is easy to change the mutability and take references or clones. /// /// ```rust /// # #[macro_use] extern crate taken; /// # fn main() { /// let (a, mut b, c, d, e, f) = (1, 2, 3, 4, 5, 6); /// take!( /// &a, // let a = &a; /// &mut b, // let b = &mut b; /// c, // let c = c; /// mut d, // let mut d = d; /// =e, // let e = e.clone(); /// =mut f, // let mut e = e.clone(); /// ); /// # } /// ``` /// /// ## Changing Ownership and Renaming /// You can also rename one or more of the variables using `as`: /// /// ```rust /// # #[macro_use] extern crate taken; /// # fn main() { /// let (var_a, mut var_b, var_c, var_d, var_e, var_f) = (1, 2, 3, 4, 5, 6); /// take!( /// &var_a as a, // let a = &var_a; /// &mut var_b as b, // let b = &mut var_b; /// var_c as c, // let c = var_c; /// mut var_d as d, // let mut d = var_d; /// =var_e as e, // let e = var_e.clone(); /// =mut var_f as f, // let mut e = var_e.clone(); /// ); /// # } /// ``` /// /// ## Usecase: Closures /// /// Closures are one of the main use cases. /// /// ``` /// #[macro_use] extern crate taken; /// /// # fn main() { /// // make them all mutable to demo that we can control /// // mutability using `take!` /// let mut w = vec![1, 2, 3]; /// let mut x = vec![1, 2, 3]; /// let mut y = vec![1, 2, 3]; /// let mut z = vec![10]; /// /// { /// let closure = || { /// take!(&w, &mut x, y, mut z); /// // w.push(5); // ERROR: cannot borrow as mutable /// x.push(4); // mutate reference to x /// z.push(10); // we own `mut z` /// /// println!("&x: {:?}", &x); /// println!("moved y: {:?}", y); /// println!("moved mut z: {:?}", z); /// // y and z are dropped /// }; /// /// closure(); /// } /// /// println!("&w after: {:?}", w); // We can still print w! /// println!("&x after: {:?}", x); // We can still print x! /// // println!("y after: {:?}", y); // ERROR: use of moved value /// // println!("z after: {:?}", z); // ERROR: use of moved value /// # } /// ``` /// /// ## Usecase: Threads /// /// Threads are another primary use case, as threads use closures. Threads in particular are always /// `FnOnce` and often find themselves cloning and moving specific variables. /// /// ```rust /// use std::thread::spawn; /// use std::sync::mpsc::channel; /// #[macro_use] extern crate taken; /// /// # fn main() { /// let (send, recv) = channel(); /// { /// let th = spawn(|| { /// take!(send); // let send = send; /// send.send("foo").unwrap(); /// }); /// th.join().unwrap(); /// } /// println!("received: {:?}", recv.into_iter().collect::<Vec<_>>()); /// # } /// ``` #[macro_export] macro_rules! take { // --------------------- // ----- with rest ----- [$var:ident, $($rest:tt)*] => { let $var = $var; take![$($rest)*] }; [$var:ident as $v:ident, $($rest:tt)*] => { let $v = $var; take![$($rest)*] }; [mut $var:ident, $($rest:tt)*] => { let mut $var = $var; take![$($rest)*] }; [mut $var:ident as $v:ident, $($rest:tt)*] => { let mut $v = $var; take![$($rest)*] }; [&$var:ident, $($rest:tt)*] => { let $var = &$var; take![$($rest)*] }; [&$var:ident as $v:ident, $($rest:tt)*] => { let $v = &$var; take![$($rest)*] }; [&mut $var:ident, $($rest:tt)*] => { let $var = &mut $var; take![$($rest)*] }; [&mut $var:ident as $v:ident, $($rest:tt)*] => { let $v = &mut $var; take![$($rest)*] }; [=$var:ident, $($rest:tt)*] => { let $var = $var.clone(); take![$($rest)*] }; [=$var:ident as $v:ident, $($rest:tt)*] => { let $v = $var.clone(); take![$($rest)*] }; [=mut $var:ident, $($rest:tt)*] => { let mut $var = $var.clone(); take![$($rest)*] }; [=mut $var:ident as $v:ident, $($rest:tt)*] => { let mut $v = $var.clone(); take![$($rest)*] }; // ------------------------ // ----- without rest ----- [$var:ident] => { let $var = $var; }; [$var:ident as $v:ident] => { let $v = $var; }; [mut $var:ident] => { let mut $var = $var; }; [mut $var:ident as $v:ident] => { let mut $v = $var; }; [&$var:ident] => { let $var = &$var; }; [&$var:ident as $v:ident] => { let $v = &$var; }; [&mut $var:ident] => { let $var = &mut $var; }; [&mut $var:ident as $v:ident] => { let $v = &mut $var; }; [=$var:ident] => { let $var = $var.clone(); }; [=$var:ident as $v:ident] => { let $v = $var.clone(); }; [=mut $var:ident] => { let mut $var = $var.clone(); }; [=mut $var:ident as $v:ident] => { let mut $v = $var.clone(); }; // trailing comma [] => {}; } #[test] #[allow(unused_mut, unused_variables, unused_assignments)] fn sanity_syntax() { let x = 1; take!(x); assert_eq!(x, 1); take!(mut x); x = 2; assert_eq!(x, 2); { take!(&mut x); *x = 1; assert_eq!(*x, 1); } { take!(&x); assert_eq!(*x, 1); } { take!(=x); assert_eq!(x, 1); } { take!(=mut x); x = 2; assert_eq!(x, 2); } assert_eq!(x, 1); } #[test] #[allow(unused_mut, unused_variables, unused_assignments)] fn sanity_syntax_comma() { // all of these just have trailing commas, which actually tests the `rest` block as well. let x = 1; take!(x,); assert_eq!(x, 1); take!(mut x,); x = 2; assert_eq!(x, 2); { take!(&mut x,); *x = 1; assert_eq!(*x, 1); } { take!(&x,); assert_eq!(*x, 1); } { take!(=x,); assert_eq!(x, 1); } { take!(=mut x,); x = 2; assert_eq!(x, 2); } assert_eq!(x, 1); } #[test] #[allow(unused_mut, unused_variables, unused_assignments)] fn sanity_syntax_as() { let mut x = 1; { take!(x as y); assert_eq!(x, y); } { take!(mut x as y); y = 2; assert_eq!(y, 2); } { take!(&mut x as y); *y = 2; assert_eq!(*y, 2); } assert_eq!(x, 2); x = 1; { take!(&x as y); assert_eq!(*y, 1); } { take!(=x as y); assert_eq!(x, y); } { take!(=mut x as y); y = 2; assert_eq!(y, 2); } assert_eq!(x, 1); } #[test] #[allow(unused_mut, unused_variables, unused_assignments)] fn sanity_multi() { { let (x, y, z) = (1, 2, 3); take!(x, y, z); } { let (x, y, z) = (1, 2, 3); take!(mut x, y, z); } { let (x, y, z) = (1, 2, 3); take!(mut x, mut y, z); } { let (x, y, z) = (1, 2, 3); take!(mut x, mut y, mut z); } { let (x, y, z) = (1, 2, 3); take!( mut x, mut y, mut z ); take!( &x, &mut y, z ); } { // with trailing comma let (x, y, z) = (1, 2, 3); take!( x, y, z, ); } }