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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
//! An attribute that would create a projection struct covering all the fields. //! //! ## Examples //! //! Structs and enums are supported. //! //! ### Structs //! //! ```rust //! use pin_project::unsafe_project; //! use std::pin::Pin; //! //! #[unsafe_project(Unpin)] //! struct Foo<T, U> { //! #[pin] //! future: T, //! field: U, //! } //! //! impl<T, U> Foo<T, U> { //! fn baz(mut self: Pin<&mut Self>) { //! let this = self.project(); //! let _: Pin<&mut T> = this.future; // Pinned reference to the field //! let _: &mut U = this.field; // Normal reference to the field //! } //! } //! //! // Automatically create the appropriate conditional Unpin implementation. //! // impl<T: Unpin, U> Unpin for Foo<T, U> {} // Conditional Unpin impl //! ``` //! //! <details> //! <summary>Code like this will be generated:</summary> //! //! ```rust //! # use std::pin::Pin; //! struct Foo<T, U> { //! future: T, //! field: U, //! } //! //! struct __FooProjection<'__a, T, U> { //! future: ::core::pin::Pin<&'__a mut T>, //! field: &'__a mut U, //! } //! //! impl<T, U> Foo<T, U> { //! fn project<'__a>(self: ::core::pin::Pin<&'__a mut Self>) -> __FooProjection<'__a, T, U> { //! unsafe { //! let this = ::core::pin::Pin::get_unchecked_mut(self); //! __FooProjection { //! future: ::core::pin::Pin::new_unchecked(&mut this.future), //! field: &mut this.field, //! } //! } //! } //! } //! //! impl<T, U> Unpin for Foo<T, U> where T: Unpin {} //! //! impl<T, U> Foo<T, U> { //! fn baz(mut self: Pin<&mut Self>) { //! let this = self.project(); //! let _: Pin<&mut T> = this.future; // Pinned reference to the field //! let _: &mut U = this.field; // Normal reference to the field //! } //! } //! ``` //! //! </details> //! //! ### Enums //! //! ```rust //! # #[cfg(feature = "project_attr")] //! use pin_project::{project, unsafe_project}; //! # #[cfg(feature = "project_attr")] //! use std::pin::Pin; //! //! # #[cfg(feature = "project_attr")] //! #[unsafe_project(Unpin)] //! enum Foo<T, U> { //! Future(#[pin] T), //! Done(U), //! } //! //! # #[cfg(feature = "project_attr")] //! impl<T, U> Foo<T, U> { //! #[project] // Nightly does not need a dummy attribute to the function. //! fn baz(mut self: Pin<&mut Self>) { //! #[project] //! match self.project() { //! Foo::Future(future) => { //! let _: Pin<&mut T> = future; //! } //! Foo::Done(value) => { //! let _: &mut U = value; //! } //! } //! } //! } //! //! // Automatically create the appropriate conditional Unpin implementation. //! // impl<T, U> Unpin for Foo<T, U> where T: Unpin {} // Conditional Unpin impl //! ``` //! //! <details> //! <summary>Code like this will be generated:</summary> //! //! ```rust //! # use std::pin::Pin; //! enum Foo<T, U> { //! Future(T), //! Done(U), //! } //! //! enum __FooProjection<'__a, T, U> { //! Future(::core::pin::Pin<&'__a mut T>), //! Done(&'__a mut U), //! } //! //! impl<T, U> Foo<T, U> { //! fn project<'__a>(self: ::core::pin::Pin<&'__a mut Self>) -> __FooProjection<'__a, T, U> { //! unsafe { //! match ::core::pin::Pin::get_unchecked_mut(self) { //! Foo::Future(_x0) => __FooProjection::Future(::core::pin::Pin::new_unchecked(_x0)), //! Foo::Done(_x0) => __FooProjection::Done(_x0), //! } //! } //! } //! } //! //! impl<T, U> Unpin for Foo<T, U> where T: Unpin {} //! //! impl<T, U> Foo<T, U> { //! fn baz(mut self: Pin<&mut Self>) { //! match self.project() { //! __FooProjection::Future(future) => { //! let _: Pin<&mut T> = future; //! } //! __FooProjection::Done(value) => { //! let _: &mut U = value; //! } //! } //! } //! } //! ``` //! //! </details> //! //! See [`unsafe_project`] and [`project`] for more details. //! //! [`unsafe_project`]: ./attr.unsafe_project.html //! [`project`]: ./attr.project.html //! #![crate_type = "proc-macro"] #![recursion_limit = "256"] #![doc(html_root_url = "https://docs.rs/pin-project/0.2.0")] #![deny(rust_2018_idioms)] extern crate proc_macro; mod enums; mod structs; mod utils; #[cfg(feature = "project_attr")] mod macros; #[cfg(feature = "unsafe_fields")] mod fields; #[cfg(feature = "unsafe_variants")] mod variants; mod compile_fail; use proc_macro::TokenStream; use syn::Item; /// An attribute that would create a projection struct covering all the fields. /// /// This attribute creates a projection struct according to the following rules: /// /// - For the field that uses `#[pin]` attribute, makes the pinned reference to /// the field. /// - For the other fields, makes the unpinned reference to the field. /// /// ## Safety /// /// For the field that uses `#[pin]` attribute, three things need to be ensured: /// /// - If the struct implements [`Drop`], the [`drop`] method is not allowed to /// move the value of the field. /// - If the struct wants to implement [`Unpin`], it has to do so conditionally: /// The struct can only implement [`Unpin`] if the field's type is [`Unpin`]. /// If you use `#[unsafe_project(Unpin)]`, you do not need to ensure this /// because an appropriate conditional [`Unpin`] implementation will be /// generated. /// - The struct must not be `#[repr(packed)]`. /// /// For the other fields, need to be ensured that the contained value not pinned /// in the current context. /// /// ## Examples /// /// Using `#[unsafe_project(Unpin)]` will automatically create the appropriate /// conditional [`Unpin`] implementation: /// /// ```rust /// use pin_project::unsafe_project; /// use std::pin::Pin; /// /// #[unsafe_project(Unpin)] /// struct Foo<T, U> { /// #[pin] /// future: T, /// field: U, /// } /// /// impl<T, U> Foo<T, U> { /// fn baz(mut self: Pin<&mut Self>) { /// let this = self.project(); /// let _: Pin<&mut T> = this.future; // Pinned reference to the field /// let _: &mut U = this.field; // Normal reference to the field /// } /// } /// /// // Automatically create the appropriate conditional Unpin implementation. /// // impl<T, U> Unpin for Foo<T, U> where T: Unpin {} // Conditional Unpin impl /// ``` /// /// If you want to implement [`Unpin`] manually: /// /// ```rust /// use pin_project::unsafe_project; /// use std::pin::Pin; /// /// #[unsafe_project] /// struct Foo<T, U> { /// #[pin] /// future: T, /// field: U, /// } /// /// impl<T, U> Foo<T, U> { /// fn baz(mut self: Pin<&mut Self>) { /// let this = self.project(); /// let _: Pin<&mut T> = this.future; // Pinned reference to the field /// let _: &mut U = this.field; // Normal reference to the field /// } /// } /// /// impl<T: Unpin, U> Unpin for Foo<T, U> {} // Conditional Unpin impl /// ``` /// /// Note that borrowing the field where `#[pin]` attribute is used multiple /// times requires using `.as_mut()` to avoid consuming the `Pin`. /// /// ## Supported Items /// /// The current version of pin-project supports the following types of items. /// /// ### Structs (structs with named fields): /// /// ```rust /// # use pin_project::unsafe_project; /// # use std::pin::Pin; /// #[unsafe_project(Unpin)] /// struct Foo<T, U> { /// #[pin] /// future: T, /// field: U, /// } /// /// impl<T, U> Foo<T, U> { /// fn baz(mut self: Pin<&mut Self>) { /// let this = self.project(); /// let _: Pin<&mut T> = this.future; /// let _: &mut U = this.field; /// } /// } /// ``` /// /// ### Tuple structs (structs with unnamed fields): /// /// ```rust /// # use pin_project::unsafe_project; /// # use std::pin::Pin; /// #[unsafe_project(Unpin)] /// struct Foo<T, U>(#[pin] T, U); /// /// impl<T, U> Foo<T, U> { /// fn baz(mut self: Pin<&mut Self>) { /// let this = self.project(); /// let _: Pin<&mut T> = this.0; /// let _: &mut U = this.1; /// } /// } /// ``` /// /// Structs without fields (unit-like struct and zero fields struct) are not /// supported. /// /// ### Enums /// /// ```rust /// # #[cfg(feature = "project_attr")] /// use pin_project::{project, unsafe_project}; /// # #[cfg(feature = "project_attr")] /// # use std::pin::Pin; /// /// # #[cfg(feature = "project_attr")] /// #[unsafe_project(Unpin)] /// enum Foo<A, B, C> { /// Tuple(#[pin] A, B), /// Struct { field: C }, /// Unit, /// } /// /// # #[cfg(feature = "project_attr")] /// impl<A, B, C> Foo<A, B, C> { /// #[project] // Nightly does not need a dummy attribute to the function. /// fn baz(self: Pin<&mut Self>) { /// #[project] /// match self.project() { /// Foo::Tuple(x, y) => { /// let _: Pin<&mut A> = x; /// let _: &mut B = y; /// } /// Foo::Struct { field } => { /// let _: &mut C = field; /// } /// Foo::Unit => {} /// } /// } /// } /// ``` /// /// Also see [`project`] attribute. /// /// Enums without variants (zero-variant enums) are not supported. /// /// [`Unpin`]: core::marker::Unpin /// [`drop`]: Drop::drop /// [`project`]: ./attr.project.html #[proc_macro_attribute] pub fn unsafe_project(args: TokenStream, input: TokenStream) -> TokenStream { match syn::parse(input) { Ok(Item::Struct(item)) => structs::unsafe_project(args, item), Ok(Item::Enum(item)) => enums::unsafe_project(args, item), _ => utils::compile_err("`unsafe_project` may only be used on structs or enums"), } } /// An attribute that would create projections for each struct fields. /// /// This is similar to [`unsafe_project`], but it is compatible with /// [pin-utils]. /// /// *This attribute is available if pin-project is built with the /// "unsafe_fields" feature.* /// /// This attribute creates methods according to the following rules: /// /// - For the field that uses `#[pin]` attribute, the method that makes the /// pinned reference to that field is created. This is the same as /// [`pin_utils::unsafe_pinned`]. /// - For the field that uses `#[skip]` attribute, the method referencing that /// field is not created. /// - For the other fields, the method that makes the unpinned reference to that /// field is created. This is the same as [`pin_utils::unsafe_unpinned`]. /// /// ## Safety /// /// For the field that uses `#[pin]` attribute, three things need to be ensured: /// /// - If the struct implements [`Drop`], the [`drop`] method is not allowed to /// move the value of the field. /// - If the struct wants to implement [`Unpin`], it has to do so conditionally: /// The struct can only implement [`Unpin`] if the field's type is [`Unpin`]. /// If you use `#[unsafe_fields(Unpin)]`, you do not need to ensure this /// because an appropriate [`Unpin`] implementation will be generated. /// - The struct must not be `#[repr(packed)]`. /// /// For the other fields, need to be ensured that the contained value not pinned /// in the current context. /// /// ## Examples /// /// Using `#[unsafe_fields(Unpin)]` will automatically create the appropriate /// [`Unpin`] implementation: /// /// ```rust /// use pin_project::unsafe_fields; /// use std::pin::Pin; /// /// #[unsafe_fields(Unpin)] /// struct Foo<T, U> { /// #[pin] /// future: T, /// field: U, /// } /// /// impl<T, U> Foo<T, U> { /// fn baz(mut self: Pin<&mut Self>) { /// let _: Pin<&mut T> = self.as_mut().future(); // Pinned reference to the field /// let _: &mut U = self.as_mut().field(); // Normal reference to the field /// } /// } /// /// // Automatically create the appropriate conditional Unpin implementation. /// // impl<T, U> Unpin for Foo<T, U> where T: Unpin {} // Conditional Unpin impl /// ``` /// /// If you want to implement [`Unpin`] manually: /// /// ```rust /// use pin_project::unsafe_fields; /// use std::pin::Pin; /// /// #[unsafe_fields] /// struct Foo<T, U> { /// #[pin] /// future: T, /// field: U, /// } /// /// impl<T, U> Foo<T, U> { /// fn baz(mut self: Pin<&mut Self>) { /// let _: Pin<&mut T> = self.as_mut().future(); // Pinned reference to the field /// let _: &mut U = self.as_mut().field(); // Normal reference to the field /// } /// } /// /// impl<T: Unpin, U> Unpin for Foo<T, U> {} // Conditional Unpin impl /// ``` /// /// Note that borrowing the field multiple times requires using `.as_mut()` to /// avoid consuming the `Pin`. /// /// [`unsafe_project`]: ./attr.unsafe_project.html /// [`Unpin`]: core::marker::Unpin /// [`drop`]: Drop::drop /// [pin-utils]: https://github.com/rust-lang-nursery/pin-utils /// [`pin_utils::unsafe_pinned`]: https://docs.rs/pin-utils/0.1.0-alpha/pin_utils/macro.unsafe_pinned.html /// [`pin_utils::unsafe_unpinned`]: https://docs.rs/pin-utils/0.1.0-alpha/pin_utils/macro.unsafe_unpinned.html #[cfg(feature = "unsafe_fields")] #[proc_macro_attribute] pub fn unsafe_fields(args: TokenStream, input: TokenStream) -> TokenStream { fields::unsafe_fields(args, input) } /// An attribute that would create projections for each enum variants. /// /// *This attribute is available if pin-project is built with the /// "unsafe_variants" feature.* /// /// This attribute creates methods according to the following rules: /// /// - For the field that uses `#[pin]` attribute, the method that makes the /// pinned reference to that field is created. /// - For the variant or field that uses `#[skip]` attribute, the method referencing that /// variant or field is not created. /// - For the unit variant, the method referencing that variant is not created. /// - For the other fields, the method that makes the unpinned reference to that /// field is created. /// /// ## Safety /// /// For the field that uses `#[pin]` attribute, three things need to be ensured: /// /// - If the enum implements [`Drop`], the [`drop`] method is not allowed to /// move the value of the field. /// - If the enum wants to implement [`Unpin`], it has to do so conditionally: /// The enum can only implement [`Unpin`] if the field's type is [`Unpin`]. /// If you use `#[unsafe_variants(Unpin)]`, you do not need to ensure this /// because an appropriate [`Unpin`] implementation will be generated. /// - The enum must not be `#[repr(packed)]`. /// /// For the other fields, need to be ensured that the contained value not pinned /// in the current context. /// /// ## Examples /// /// Using `#[unsafe_variants(Unpin)]` will automatically create the appropriate /// [`Unpin`] implementation: /// /// ```rust /// use pin_project::unsafe_variants; /// use std::pin::Pin; /// /// #[unsafe_variants(Unpin)] /// enum Foo<A, B, C> { /// Variant1(#[pin] A, B), /// Variant2(C), /// } /// /// impl<A, B, C> Foo<A, B, C> { /// fn baz(mut self: Pin<&mut Self>) { /// let _: Pin<&mut A> = self.as_mut().variant1().unwrap().0; // Pinned reference to the field /// let _: &mut B = self.as_mut().variant1().unwrap().1; // Normal reference to the field /// let _: Option<&mut C> = self.as_mut().variant2(); /// } /// } /// /// // Automatically create the appropriate conditional Unpin implementation. /// // impl<A, B, C> Unpin for Foo<A, B, C> where A: Unpin {} // Conditional Unpin impl /// ``` /// /// If you want to implement [`Unpin`] manually: /// /// ```rust /// use pin_project::unsafe_variants; /// use std::pin::Pin; /// /// #[unsafe_variants] /// enum Foo<A, B, C> { /// Variant1(#[pin] A, B), /// Variant2(C), /// } /// /// impl<A, B, C> Foo<A, B, C> { /// fn baz(mut self: Pin<&mut Self>) { /// let _: Pin<&mut A> = self.as_mut().variant1().unwrap().0; // Pinned reference to the field /// let _: &mut B = self.as_mut().variant1().unwrap().1; // Normal reference to the field /// let _: Option<&mut C> = self.as_mut().variant2(); /// } /// } /// /// impl<A, B, C> Unpin for Foo<A, B, C> where A: Unpin {} // Conditional Unpin impl /// ``` /// /// Note that borrowing the variant multiple times requires using `.as_mut()` to /// avoid consuming the `Pin`. /// /// [`Unpin`]: core::marker::Unpin /// [`drop`]: Drop::drop #[cfg(feature = "unsafe_variants")] #[proc_macro_attribute] pub fn unsafe_variants(args: TokenStream, input: TokenStream) -> TokenStream { variants::unsafe_variants(args, input) } /// An attribute to support pattern matching. /// /// *This attribute is available if pin-project is built with the /// "project_attr" feature (it is enabled by default).* /// /// ## Examples /// /// ### `let` bindings /// /// ```rust /// use pin_project::{project, unsafe_project}; /// # use std::pin::Pin; /// /// #[unsafe_project(Unpin)] /// struct Foo<T, U> { /// #[pin] /// future: T, /// field: U, /// } /// /// impl<T, U> Foo<T, U> { /// #[project] // Nightly does not need a dummy attribute to the function. /// fn baz(mut self: Pin<&mut Self>) { /// #[project] /// let Foo { future, field } = self.project(); /// /// let _: Pin<&mut T> = future; /// let _: &mut U = field; /// } /// } /// ``` /// /// ### `match` expressions /// /// ```rust /// use pin_project::{project, unsafe_project}; /// # use std::pin::Pin; /// /// #[unsafe_project(Unpin)] /// enum Foo<A, B, C> { /// Tuple(#[pin] A, B), /// Struct { field: C }, /// Unit, /// } /// /// impl<A, B, C> Foo<A, B, C> { /// #[project] // Nightly does not need a dummy attribute to the function. /// fn baz(self: Pin<&mut Self>) { /// #[project] /// match self.project() { /// Foo::Tuple(x, y) => { /// let _: Pin<&mut A> = x; /// let _: &mut B = y; /// } /// Foo::Struct { field } => { /// let _: &mut C = field; /// } /// Foo::Unit => {} /// } /// } /// } /// ``` /// /// ### `if let` expressions /// /// When used against `if let` expressions, the `#[project]` attribute records /// the name of the structure destructed with the first `if let`. Destructing /// different structures in the after second times will not generate wrong code. /// /// ```rust /// use pin_project::{project, unsafe_project}; /// # use std::pin::Pin; /// /// #[unsafe_project(Unpin)] /// enum Foo<A, B, C> { /// Tuple(#[pin] A, B), /// Struct { field: C }, /// Unit, /// } /// /// impl<A, B, C> Foo<A, B, C> { /// #[project] // Nightly does not need a dummy attribute to the function. /// fn baz(self: Pin<&mut Self>) { /// #[project] /// { /// if let Foo::Tuple(x, y) = self.project() { /// let _: Pin<&mut A> = x; /// let _: &mut B = y; /// } /// } /// } /// } /// ``` #[cfg(feature = "project_attr")] #[proc_macro_attribute] pub fn project(args: TokenStream, input: TokenStream) -> TokenStream { assert!(args.is_empty()); macros::project(input) }