pin-project

An attribute that creates a projection struct covering all the fields.

Documentation

Usage

Add this to your Cargo.toml:

toml [dependencies] pin-project = "0.3"

The current version of pin-project requires Rust 1.33 or later.

Examples

[unsafe_project] attribute creates a projection struct covering all the fields.

```rust use pinproject::unsafeproject; use std::pin::Pin;

[unsafe_project(Unpin)] // `(Unpin)` is optional (create the appropriate conditional Unpin implementation)

struct Foo { #[pin] future: T, field: U, }

impl Foo { 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 (optional). // impl Unpin for Foo where T: Unpin {} ```

Code like this will be generated

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