aboutsummaryrefslogtreecommitdiff
path: root/CHANGELOG.md
blob: fc1b7d1fb9b279d3d694f45a034b4b66c56bcf9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# Changelog

All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](https://semver.org).

<!--
Note: In this file, do not use the hard wrap in the middle of a sentence for compatibility with GitHub comment style markdown rendering.
-->

## [Unreleased]

## [0.2.1] - 2021-01-05

- Exclude unneeded files from crates.io.

## [0.2.0] - 2020-11-13

- [`pin_project!` macro now supports enums.][28]

  To use `pin_project!` on enums, you need to name the projection type returned from the method.

  ```rust
  use pin_project_lite::pin_project;
  use std::pin::Pin;

  pin_project! {
      #[project = EnumProj]
      enum Enum<T, U> {
          Variant { #[pin] pinned: T, unpinned: U },
      }
  }

  impl<T, U> Enum<T, U> {
      fn method(self: Pin<&mut Self>) {
          match self.project() {
              EnumProj::Variant { pinned, unpinned } => {
                  let _: Pin<&mut T> = pinned;
                  let _: &mut U = unpinned;
              }
          }
      }
  }
  ```

- [Support naming the projection types.][28]

  By passing an attribute with the same name as the method, you can name the projection type returned from the method:

  ```rust
  use pin_project_lite::pin_project;
  use std::pin::Pin;

  pin_project! {
      #[project = StructProj]
      struct Struct<T> {
          #[pin]
          field: T,
      }
  }

  fn func<T>(x: Pin<&mut Struct<T>>) {
      let StructProj { field } = x.project();
      let _: Pin<&mut T> = field;
  }
  ```

[28]: https://github.com/taiki-e/pin-project-lite/pull/28

## [0.1.11] - 2020-10-20

- Suppress `clippy::redundant_pub_crate` lint in generated code.

- Documentation improvements.

## [0.1.10] - 2020-10-01

- Suppress `drop_bounds` lint, which will be added to rustc in the future. See [taiki-e/pin-project#272](https://github.com/taiki-e/pin-project/issues/272) for more details.

## [0.1.9] - 2020-09-29

- Fix trailing comma support in generics

## [0.1.8] - 2020-09-26

- Fix compatibility of generated code with `forbid(future_incompatible)`

  Note: This does not guarantee compatibility with `forbid(future_incompatible)` in the future.
  If rustc adds a new lint, we may not be able to keep this.

## [0.1.7] - 2020-06-04

- [Support `?Sized` bounds in where clauses.][22]

- [Fix lifetime inference error when an associated type is used in fields.][20]

- Suppress `clippy::used_underscore_binding` lint in generated code.

- Documentation improvements.

[20]: https://github.com/taiki-e/pin-project-lite/pull/20
[22]: https://github.com/taiki-e/pin-project-lite/pull/22

## [0.1.6] - 2020-05-31

- [Support lifetime bounds in where clauses.][18]

- Documentation improvements.

[18]: https://github.com/taiki-e/pin-project-lite/pull/18

## [0.1.5] - 2020-05-07

- [Support overwriting the name of core crate.][14]

[14]: https://github.com/taiki-e/pin-project-lite/pull/14

## [0.1.4] - 2020-01-20

- [Support ?Sized bounds in generic parameters.][9]

[9]: https://github.com/taiki-e/pin-project-lite/pull/9

## [0.1.3] - 2020-01-20

- [Support lifetime bounds in generic parameters.][7]

[7]: https://github.com/taiki-e/pin-project-lite/pull/7

## [0.1.2] - 2020-01-05

- [Support recognizing default generic parameters.][6]

[6]: https://github.com/taiki-e/pin-project-lite/pull/6

## [0.1.1] - 2019-11-15

- [`pin_project!` macro now determines the visibility of the projection type/method is based on the original type.][5]

[5]: https://github.com/taiki-e/pin-project-lite/pull/5

## [0.1.0] - 2019-10-22

Initial release

[Unreleased]: https://github.com/taiki-e/pin-project-lite/compare/v0.2.1...HEAD
[0.2.1]: https://github.com/taiki-e/pin-project-lite/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.11...v0.2.0
[0.1.11]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.10...v0.1.11
[0.1.10]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.9...v0.1.10
[0.1.9]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.8...v0.1.9
[0.1.8]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.7...v0.1.8
[0.1.7]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.6...v0.1.7
[0.1.6]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.5...v0.1.6
[0.1.5]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.4...v0.1.5
[0.1.4]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.3...v0.1.4
[0.1.3]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.2...v0.1.3
[0.1.2]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/taiki-e/pin-project-lite/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/taiki-e/pin-project-lite/releases/tag/v0.1.0