diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 16 insertions, 10 deletions
@@ -3,9 +3,10 @@ [![crates.io](https://img.shields.io/crates/v/pin-project?style=flat-square&logo=rust)](https://crates.io/crates/pin-project) [![docs.rs](https://img.shields.io/badge/docs.rs-pin--project-blue?style=flat-square&logo=docs.rs)](https://docs.rs/pin-project) [![license](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue?style=flat-square)](#license) -[![rustc](https://img.shields.io/badge/rustc-1.37+-blue?style=flat-square&logo=rust)](https://www.rust-lang.org) -[![build status](https://img.shields.io/github/workflow/status/taiki-e/pin-project/CI/main?style=flat-square&logo=github)](https://github.com/taiki-e/pin-project/actions) +[![rustc](https://img.shields.io/badge/rustc-1.56+-blue?style=flat-square&logo=rust)](https://www.rust-lang.org) +[![build status](https://img.shields.io/github/actions/workflow/status/taiki-e/pin-project/ci.yml?branch=main&style=flat-square&logo=github)](https://github.com/taiki-e/pin-project/actions) +<!-- tidy:crate-doc:start --> A crate for safe and ergonomic [pin-projection]. ## Usage @@ -17,7 +18,7 @@ Add this to your `Cargo.toml`: pin-project = "1" ``` -*Compiler support: requires rustc 1.37+* +*Compiler support: requires rustc 1.56+* ## Examples @@ -25,9 +26,10 @@ pin-project = "1" covering all the fields of struct or enum. ```rust -use pin_project::pin_project; use std::pin::Pin; +use pin_project::pin_project; + #[pin_project] struct Struct<T, U> { #[pin] @@ -50,9 +52,10 @@ To use `#[pin_project]` on enums, you need to name the projection type returned from the method. ```rust -use pin_project::pin_project; use std::pin::Pin; +use pin_project::pin_project; + #[pin_project(project = EnumProj)] enum Enum<T, U> { Pinned(#[pin] T), @@ -75,19 +78,22 @@ impl<T, U> Enum<T, U> { [*code like this will be generated*][enum-default-expanded] -See [documentation](https://docs.rs/pin-project) for more details, and +See [`#[pin_project]`][`pin_project`] attribute 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. -[`pin_project`]: https://docs.rs/pin-project/1/pin_project/attr.pin_project.html -[enum-default-expanded]: examples/enum-default-expanded.rs -[examples]: examples/README.md +[enum-default-expanded]: https://github.com/taiki-e/pin-project/blob/HEAD/examples/enum-default-expanded.rs +[examples]: https://github.com/taiki-e/pin-project/blob/HEAD/examples/README.md [pin-project-lite]: https://github.com/taiki-e/pin-project-lite [pin-projection]: https://doc.rust-lang.org/std/pin/index.html#projections-and-structural-pinning -[struct-default-expanded]: examples/struct-default-expanded.rs +[struct-default-expanded]: https://github.com/taiki-e/pin-project/blob/HEAD/examples/struct-default-expanded.rs + +<!-- tidy:crate-doc:end --> + +[`pin_project`]: https://docs.rs/pin-project/1/pin_project/attr.pin_project.html ## License |