TEST_MAPPING: test dependers of this crate am: cd6b1713c1

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/pin-project/+/1488755

Change-Id: Ic4aafebc9c709c55b93dfa4d2cfbe9f739f08a0d
tree: 965721ef9d81e1cdb1b4b0c7b0634a77775c4cad
  1. .github/
  2. ci/
  3. examples/
  4. patches/
  5. scripts/
  6. src/
  7. tests/
  8. .cargo_vcs_info.json
  9. .editorconfig
  10. .gitattributes
  11. .gitignore
  12. Android.bp
  13. Cargo.toml
  14. Cargo.toml.orig
  15. CHANGELOG.md
  16. CODE_OF_CONDUCT.md
  17. LICENSE-APACHE
  18. LICENSE-MIT
  19. METADATA
  20. MODULE_LICENSE_APACHE2
  21. OWNERS
  22. README.md
  23. rustfmt.toml
  24. TEST_MAPPING
README.md

pin-project

crates-badge docs-badge license-badge rustc-badge

A crate for safe and ergonomic pin-projection.

Usage

Add this to your Cargo.toml:

[dependencies]
pin-project = "1"

The current pin-project requires Rust 1.37 or later.

Examples

#[pin_project] attribute creates projection types covering all the fields of struct or enum.

use pin_project::pin_project;
use std::pin::Pin;

#[pin_project]
struct Struct<T, U> {
    #[pin]
    pinned: T,
    unpinned: U,
}

impl<T, U> Struct<T, U> {
    fn method(self: Pin<&mut Self>) {
        let this = self.project();
        let _: Pin<&mut T> = this.pinned; // Pinned reference to the field
        let _: &mut U = this.unpinned; // Normal reference to the field
    }
}

code like this will be generated

To use #[pin_project] on enums, you need to name the projection type returned from the method.

use pin_project::pin_project;
use std::pin::Pin;

#[pin_project(project = EnumProj)]
enum Enum<T, U> {
    Pinned(#[pin] T),
    Unpinned(U),
}

impl<T, U> Enum<T, U> {
    fn method(self: Pin<&mut Self>) {
        match self.project() {
            EnumProj::Pinned(x) => {
                let _: Pin<&mut T> = x;
            }
            EnumProj::Unpinned(y) => {
                let _: &mut U = y;
            }
        }
    }
}

code like this will be generated

See documentation for more details, and see examples directory for more examples and generated code.

Related Projects

  • pin-project-lite: A lightweight version of pin-project written with declarative macros.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.