Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / pin-project / 127364b149c24623fd15786790a98af3b5355389
commit127364b149c24623fd15786790a98af3b5355389[log] [tgz]
authorChih-Hung Hsieh <chh@google.com>Mon Oct 26 16:54:29 2020 -0700
committerChih-Hung Hsieh <chh@google.com>Mon Oct 26 16:57:40 2020 -0700
tree55ba197683b0a0093a2767fcb1f576490157f8a1
parentc112e35face1579eba180108bda3da10b61d9926 [diff]
Upgrade rust/crates/pin-project to 1.0.1

* Add missing patches, needed by external_updater

Test: make
Test: tools/external_updater/updater.sh update --refresh --keep_date rust/crates/pin-project
Change-Id: I3738561830ce97903036460713eb3b74700b889e
142 files changed
tree: 55ba197683b0a0093a2767fcb1f576490157f8a1
  1. .github/
  2. ci/
  3. examples/
  4. patches/
  5. scripts/
  6. src/
  7. tests/
  8. LICENSE ⇨ LICENSE-APACHE
  9. NOTICE ⇨ LICENSE
  10. .cargo_vcs_info.json
  11. .editorconfig
  12. .gitattributes
  13. .gitignore
  14. Android.bp
  15. Cargo.toml
  16. Cargo.toml.orig
  17. CHANGELOG.md
  18. CODE_OF_CONDUCT.md
  19. LICENSE-APACHE
  20. LICENSE-MIT
  21. METADATA
  22. MODULE_LICENSE_APACHE2
  23. OWNERS
  24. README.md
  25. rustfmt.toml
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.