#macros #attribute #pin

macro pin-project

An attribute that would create a projection struct covering all the fields

3 releases

✓ Uses Rust 2018 edition

new 0.1.2 Jan 9, 2019
0.1.1 Jan 8, 2019
0.1.0 Jan 8, 2019

#9 in #attribute

Download history 18/week @ 2019-01-09

6 downloads per month

Apache-2.0/MIT

9KB
89 lines

pin-project

Build Status version documentation license

An attribute that would create a projection struct covering all the fields.

Documentation

Usage

Add this to your Cargo.toml:

[dependencies]
pin-project = "0.1"

Now, you can use pin-project:

use pin_project::unsafe_project;

The current version of pin-project requires Rust nightly 2018-12-26 or later.

Examples

use pin_project::unsafe_project;
use std::marker::Unpin;
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

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.

Dependencies