commit	877ecd6a34c5af7d0b1661a3fbb47d36ac65665e	[log] [tgz]
author	Matthew Maurer <mmaurer@google.com>	Tue Jul 07 00:35:16 2020 +0000
committer	Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>	Tue Jul 07 00:35:16 2020 +0000
tree	edf022dd54a322e087cc385a24e21741105f508f
parent	de3fc4cd3b2560cfb0ad7e2d1421271b5aa661d1 [diff]
parent	27022a622ddfd7610300fe6766d128b7742bb213 [diff]

tree: edf022dd54a322e087cc385a24e21741105f508f

README.md

pin-project

A crate for safe and ergonomic pin-projection.

Usage

Add this to your Cargo.toml:

[dependencies]
pin-project = "0.4"

The current pin-project requires Rust 1.34 or later.

Examples

pin_project attribute creates a projection struct covering all the fields.

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 foo(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

See API documentation for more details.

Also, there are examples and generated code of each feature in examples directory.

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.